BdsApi
2.2.2
This is the Blacknest BDS API.
|
This class defines information on a single channels set of data stored in a file. More...
#include <BdsD.h>
Public Member Functions | |
DataChannel (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString station=BString(), BString channel=BString(), BString source=BString(), BUInt32 numBlocks=0, BUInt64 numSamples=0, BFloat64 sampleRate=0, BUInt32 sampleFormat=0, BUInt32 dataFileId=0, BUInt32 dataFileChannel=0, BString importFormat=BString(), BString importFilename=BString(), BTimeStamp importStartTime=BTimeStamp(), BDict< BString > info=BDict< BString >()) | |
BString | getType () |
BError | setMembers (BDictString &members) |
BError | setMember (BString name, BString value) |
BError | getMembers (BDictString &members) |
BError | getMember (BString name, BString &value) |
![]() | |
BObj () | |
virtual | ~BObj () |
virtual const char * | getType () const |
virtual const BObjMember * | getMembers () const |
virtual void | membersPrint () const |
virtual BString | getDebugString () |
Public Attributes | |
BUInt32 | id |
Unique ID when stored in a database or for other uses. More... | |
BTimeStamp | startTime |
The Start Time. More... | |
BTimeStamp | endTime |
The End Time. More... | |
BString | network |
The Network Name. More... | |
BString | station |
The Station name. More... | |
BString | channel |
The Channels name. More... | |
BString | source |
The Data Source. More... | |
BUInt32 | numBlocks |
The total number of blocks per channel if known, 0 otherwise. More... | |
BUInt64 | numSamples |
The total number of samples per channel if known, 0 otherwise. More... | |
BFloat64 | sampleRate |
The data's sample rate. More... | |
BUInt32 | sampleFormat |
The data sample format. More... | |
BUInt32 | dataFileId |
The Data File Id. This links to the particular DataFileInfo where the data is stored. More... | |
BUInt32 | dataFileChannel |
The Data File Channel number. The channel number within the data file. (1, 2, 3 ...) More... | |
BString | importFormat |
The original data format. More... | |
BString | importFilename |
The original data file name. More... | |
BTimeStamp | importStartTime |
The original import files start time. More... | |
BDict< BString > | info |
Extra info on the channel. More... | |
This class defines information on a single channels set of data stored in a file.
This provides information on actual seismic data for a channel that is stored in the BDS system. The data will be stored in a particular file perhaps with other data channels. When known information on the channels numBlocks, numSamples and sampleRate will be provided. Generally this information will only be know if a data files has been imported rather than a live real-time data stream. Generally the seismic data file itself should be interrogated to find the definitive information. The info field provides extra details on the data contents which might come from one of the spefic data import formats.
Bds::DataChannel::DataChannel | ( | BUInt32 | id = 0 , |
BTimeStamp | startTime = BTimeStamp() , |
||
BTimeStamp | endTime = BTimeStamp() , |
||
BString | network = BString() , |
||
BString | station = BString() , |
||
BString | channel = BString() , |
||
BString | source = BString() , |
||
BUInt32 | numBlocks = 0 , |
||
BUInt64 | numSamples = 0 , |
||
BFloat64 | sampleRate = 0 , |
||
BUInt32 | sampleFormat = 0 , |
||
BUInt32 | dataFileId = 0 , |
||
BUInt32 | dataFileChannel = 0 , |
||
BString | importFormat = BString() , |
||
BString | importFilename = BString() , |
||
BTimeStamp | importStartTime = BTimeStamp() , |
||
BDict< BString > | info = BDict<BString >() |
||
) |
Reimplemented from BObj.
|
virtual |
Reimplemented from BObj.
BString Bds::DataChannel::getType | ( | ) |
|
virtual |
Reimplemented from BObj.
BString Bds::DataChannel::channel |
The Channels name.
BUInt32 Bds::DataChannel::dataFileChannel |
The Data File Channel number. The channel number within the data file. (1, 2, 3 ...)
BUInt32 Bds::DataChannel::dataFileId |
The Data File Id. This links to the particular DataFileInfo where the data is stored.
BTimeStamp Bds::DataChannel::endTime |
The End Time.
BUInt32 Bds::DataChannel::id |
Unique ID when stored in a database or for other uses.
BString Bds::DataChannel::importFilename |
The original data file name.
BString Bds::DataChannel::importFormat |
The original data format.
BTimeStamp Bds::DataChannel::importStartTime |
The original import files start time.
BUInt32 Bds::DataChannel::numBlocks |
The total number of blocks per channel if known, 0 otherwise.
BUInt64 Bds::DataChannel::numSamples |
The total number of samples per channel if known, 0 otherwise.
BUInt32 Bds::DataChannel::sampleFormat |
The data sample format.
BFloat64 Bds::DataChannel::sampleRate |
The data's sample rate.
BTimeStamp Bds::DataChannel::startTime |
The Start Time.