BdsApi  2.2.5
This is the Blacknest BDS API.
Classes | Namespaces | Functions | Variables
BdsLib.h File Reference

General BdsLib API functions. More...

#include <BdsD.h>
#include <BdsC.h>
#include <BString.h>

Go to the source code of this file.

Classes

class  Bds::ResponseObj
 Response object adding string conversion. More...
 
class  Bds::DataError
 This stores a data error. It includes and error number and a string as well as information on what seismic channel it is for. More...
 

Namespaces

 Bds
 

Functions

void Bds::bdsChannelGetTypeAux (BString name, BString &type, BString &aux)
 Get the channel type and aux fields from a generic channel name. More...
 
BString Bds::bdsChannelGetName (BString type, BString aux)
 Create a full channel name from a channels type and aux fields. More...
 
BError Bds::bdsDataInfoSetTimeRange (DataInfo &dataInfo)
 Restricts the time tange of all of the DataInfo's channels to match the DataInfo's startTime/endTime fields. More...
 
BError Bds::bdsDataInfoFromInfo (BDictString info, DataInfo &dataInfo, Bool append)
 Convert info to DataInfo. More...
 
BError Bds::bdsInfoFromDataInfo (const DataInfo &dataInfo, BDictString &info)
 Converts a DataInfo object into a BDictString list of named strings. More...
 
BError Bds::bdsDataInfoFlatten (DataInfo &dataInfo)
 Flattens a DataInfo to 1 segement per channel for use in dataOpen() calls. More...
 
BError Bds::bdsDataInfoMergeFlatten (DataInfo &dataInfo, const DataInfo &dataInfoAdd)
 Merges a DataInfo into another flattening the segments to 1 for use in dataOpen() calls. More...
 
BString Bds::bdsStationAlias (Station station)
 Returns the station alias if set else its name. More...
 
BString Bds::bdsDataChannelInfo (const DataChannel &dataChannel)
 Returns a string representation of a DataChannel object. More...
 
BString Bds::bdsDataChannelRef (const DataChannel &dataChannel)
 Returns the string reference name of a DataChannel object. More...
 
BString Bds::bdsDataChannelRef (const ChannelInfo &channelInfo)
 Returns the string reference name of a ChannelInfo object. More...
 
BError Bds::bdsDataChannelOverallResponse (const ChannelInfo &channelInfo, Response &response)
 Returns the overal response from the list of responses in a ChannelInfo. More...
 
BString Bds::bdsSelectionChannelInfo (const Selection &selection, BUInt channel)
 Returns a string describing the name and time period of a selection channel. More...
 
BString Bds::bdsFileNameExpand (BString fileName, ChannelInfo &channelInfo)
 Default filename from a ChannelInfo. More...
 
BString Bds::bdsFileNameExpand (BString fileName, ChannelInfos &channelInfos)
 Default filename from a list of ChannelInfo's. More...
 
double Bds::bdsPoleZeroGain (const PoleZero &poleZero, double frequency)
 Calculates the overal gain of the given PoleZero transfer function. More...
 
void Bds::bdsPoleZeroGainPhase (const PoleZero &poleZero, double frequency, double &gain, double &phase)
 Calculates the overal gain and phase of the given PoleZero transfer function. More...
 
void Bds::bdsPoleZeroToFap (const PoleZero &poleZero, BUInt nPoints, double calibrationFrequency, double sampleFrequency, BArray< Fap > &fap)
 Convert PoleZero to FAP. More...
 
void Bds::bdsDumpSelection (Selection sel)
 Debug print out a Selection object. More...
 
void Bds::bdsDumpDataInfo (DataInfo dataInfo, int includeInfo=0)
 Debug print out a DataInfo object. More...
 
void Bds::bdsDumpChannelInfos (const ChannelInfos &channelInfos)
 Debug print out a ChannelInfos object. More...
 
void Bds::bdsDumpData (const DataBlock &dataBlock, int nSamples=0)
 Debug print out a DataBlock object. More...
 
void Bds::bdsDumpPoleZeros (PoleZero poleZeros)
 Debug print out a PoleZeros object. More...
 

Variables

const int Bds::NetworkNameLen = 3
 Maximum Network name length. More...
 
const int Bds::StationNameLen = 5
 Maximum Station name length. More...
 
const int Bds::ChannelTypeLen = 3
 Maximum Channel type name length. More...
 
const int Bds::ChannelAuxLen = 2
 Maximum Channel Aux length. More...
 
const int Bds::SourceLen = 16
 Maximum Source length. More...
 

Detailed Description

General BdsLib API functions.