Function |
Description |
BError getSelectionInfo(SelectionGroup group, SelectionInfo selectionInfo) |
Returns information on all the Networks, Stations, Channels
and Sources that the BDS system knows about. Useful for GUI driven data
selectors. |
BError getSelections(SelectionGroup group, Selection selectionIn, Selection& selectionOut); |
Expands the given selection to match the data contents of the BDS system |
BError dataSearch(Selection selection, DataInfo& dataInfo); |
Searches for data matching the given selection and returns information on the associated data channels. |
BError dataGetChannelInfo(DataInfo dataInfo, BList<ChannelInfo> channelInfos); |
Returns the channel MetaData in structured form |
|
|
BError dataOpen(DataInfo dataInfo, String mode, String format, DataHandle& dataHandle); |
Opens a data stream. This will open a data stream which will
contain all of the channels listed in dataInfo. The mode will
be "w" for writing data and "r" for reading data. The format will be
one of: API, BDS, BKNAS, IMS1.0 etc.
API defines the BdsApi access scheme. |
void dataClose(DataHandle dataHandle) |
Closes the stream |
|
|
API Stream Write Interface |
|
BError dataSetInfo(DataHandle dataHandle, DataInfo& dataInfo) |
Provides information on the data. This is used to create file
headers etc. |
BError dataPutBlock(DataHandle dataHandle, DataBlock& data) |
Writes a data block to the file. These have to be sequential. |
|
|
API Stream Read Interface |
|
BError dataGetInfo(DataHandle dataHandle, DataInfo& dataInfo) |
Gets information on the data from the files data
header and perhaps the data blocks. This will include the real sample
rate and actual number of samples. |
BError dataGetWarnings(DataHandle dataHandle, BStringList& warnings); |
Return a list or warnings. |
BError seekBlock(DataHandle dataHandle, BUInt32 channel, UInt32 segment, BTimeStamp time, BUInt32& blockNumber) |
Seeks to a particular data block given a time. This can
operate on a single channel if a channel number is given or on multiple
channels if channel number is 0. The segment parameter is the data segment number. |
BError dataGetBlock(DataHandle dataHandle, BUInt32 channel, UInt32 segment, BUInt32 blockNumber, DataBlock& data); |
Reads a data block from the file. If the channel number is
given, then it reads data from a given channel. If the channel number is 0 it will read
a set of data from all of the channels in sample multiplexd form if this is possible. The segment parameter is the data segment number. |
|
|
Formatted Stream Read Interface |
|
BError dataFormatedRead(DataHandle dataHandle, UInt32 number, Array<UInt8>& data) |
Returns the next set of bytes of pre-formatted data. For example BKNAS, IMS etc. |
BError dataFormattedGetLength(DataHandle dataHandle, UInt64& length);
|
The total length in bytes of the formated data. |