BDS Public
BdsApi 4.0.1
This is the Blacknest BDS API.
Loading...
Searching...
No Matches

This class defines information on a set of data. More...

#include <BdsD.h>

Public Member Functions

 DataInfo (BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString array=BString(), BString description=BString(), BUInt32 synchronous=0, BArray< BArray< DataChannel > > channels=BArray< BArray< DataChannel > >(), BDict< BString > info=BDict< BString >(), BDict< BString > infoExtra=BDict< BString >(), BList< BString > warnings=BList< BString >())
 

Public Attributes

BTimeStamp startTime
 The Start Time.
 
BTimeStamp endTime
 The End Time.
 
BString array
 The Seismic Array that all of the channels are from, if just one.
 
BString description
 The Comment.
 
BUInt32 synchronous
 The channels are synchronously sampled.
 
BArray< BArray< DataChannel > > channels
 The Data channels. Each channel can have multiple segments of data.
 
BDict< BStringinfo
 Info on the set of channels.
 
BDict< BStringinfoExtra
 Extra Info on the set of channels. Used for extended error/logging information.
 
BList< BStringwarnings
 Warnings on the data set.
 

Detailed Description

This class defines information on a set of data.

This describes a set of Sensor data. It is used to returning basic Sensor data information when performing a selection of data or detailed information when enquiring information from an actual Sensor data file. All of the detailed information comes from the Sensor data files themselves. This includes the info, infoExtra and warnings information. The channels array contains an array of data segments per channel split at time discontinuities. For basic information this could be a single segment over a time period. However, when equiring detailed information from a file it will contain an entry per contiguous data segemnt in the file.

Constructor & Destructor Documentation

◆ DataInfo()

Bds::DataInfo::DataInfo ( BTimeStamp  startTime = BTimeStamp(),
BTimeStamp  endTime = BTimeStamp(),
BString  array = BString(),
BString  description = BString(),
BUInt32  synchronous = 0,
BArray< BArray< DataChannel > >  channels = BArray<BArray<DataChannel > >(),
BDict< BString info = BDict<BString >(),
BDict< BString infoExtra = BDict<BString >(),
BList< BString warnings = BList<BString >() 
)

Member Data Documentation

◆ startTime

BTimeStamp Bds::DataInfo::startTime

The Start Time.

◆ endTime

BTimeStamp Bds::DataInfo::endTime

The End Time.

◆ array

BString Bds::DataInfo::array

The Seismic Array that all of the channels are from, if just one.

◆ description

BString Bds::DataInfo::description

The Comment.

◆ synchronous

BUInt32 Bds::DataInfo::synchronous

The channels are synchronously sampled.

◆ channels

BArray<BArray<DataChannel > > Bds::DataInfo::channels

The Data channels. Each channel can have multiple segments of data.

◆ info

BDict<BString > Bds::DataInfo::info

Info on the set of channels.

◆ infoExtra

BDict<BString > Bds::DataInfo::infoExtra

Extra Info on the set of channels. Used for extended error/logging information.

◆ warnings

BList<BString > Bds::DataInfo::warnings

Warnings on the data set.


The documentation for this class was generated from the following files: