BdsApi  2.2.5
This is the Blacknest BDS API.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Public Attributes | List of all members
Bds::Digitiser Class Reference

This class defines a seismic Digitiser. More...

#include <BdsD.h>

Inheritance diagram for Bds::Digitiser:
BObj

Public Member Functions

 Digitiser (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString name=BString(), BString type=BString(), BString serialNumber=BString(), BUInt32 numberChannels=0, BFloat64 baseSamplingFrequency=0, BFloat64 initialSamplingFrequency=0, BFloat64 gain=0, BInt32 shared=0)
 
BString getType ()
 
BError setMembers (BDictString &members)
 
BError setMember (BString name, BString value)
 
BError getMembers (BDictString &members)
 
BError getMember (BString name, BString &value)
 
- Public Member Functions inherited from BObj
 BObj ()
 
virtual ~BObj ()
 
virtual const char * getType () const
 
virtual const BObjMembergetMembers () const
 
virtual void membersPrint () const
 
virtual BString getDebugString ()
 

Public Attributes

BUInt32 id
 The ID. More...
 
BTimeStamp startTime
 The Start Time. More...
 
BTimeStamp endTime
 The End Time the channel was available. More...
 
BString name
 The Digitisers name. More...
 
BString type
 The Digitisers type. More...
 
BString serialNumber
 The digitisers's serial number. More...
 
BUInt32 numberChannels
 The number of supported channels. More...
 
BFloat64 baseSamplingFrequency
 The base sampling frequency. More...
 
BFloat64 initialSamplingFrequency
 The initial pre-decimation sampling frequency. More...
 
BFloat64 gain
 The overall gain of the digitiser at the manufacturers calibration frequency. (For information only) More...
 
BInt32 shared
 This digitiser is shared. More...
 

Detailed Description

This class defines a seismic Digitiser.

This just stores information on the seismic instrument's digitiser. Its contents is generally for information only.

Constructor & Destructor Documentation

Bds::Digitiser::Digitiser ( BUInt32  id = 0,
BTimeStamp  startTime = BTimeStamp(),
BTimeStamp  endTime = BTimeStamp(),
BString  name = BString(),
BString  type = BString(),
BString  serialNumber = BString(),
BUInt32  numberChannels = 0,
BFloat64  baseSamplingFrequency = 0,
BFloat64  initialSamplingFrequency = 0,
BFloat64  gain = 0,
BInt32  shared = 0 
)

Member Function Documentation

BError Bds::Digitiser::getMember ( BString  name,
BString value 
)
virtual

Reimplemented from BObj.

BError Bds::Digitiser::getMembers ( BDictString members)
virtual

Reimplemented from BObj.

BString Bds::Digitiser::getType ( )
BError Bds::Digitiser::setMember ( BString  name,
BString  value 
)
virtual

Reimplemented from BObj.

BError Bds::Digitiser::setMembers ( BDictString members)
virtual

Reimplemented from BObj.

Member Data Documentation

BFloat64 Bds::Digitiser::baseSamplingFrequency

The base sampling frequency.

BTimeStamp Bds::Digitiser::endTime

The End Time the channel was available.

BFloat64 Bds::Digitiser::gain

The overall gain of the digitiser at the manufacturers calibration frequency. (For information only)

BUInt32 Bds::Digitiser::id

The ID.

BFloat64 Bds::Digitiser::initialSamplingFrequency

The initial pre-decimation sampling frequency.

BString Bds::Digitiser::name

The Digitisers name.

BUInt32 Bds::Digitiser::numberChannels

The number of supported channels.

BString Bds::Digitiser::serialNumber

The digitisers's serial number.

BInt32 Bds::Digitiser::shared

This digitiser is shared.

BTimeStamp Bds::Digitiser::startTime

The Start Time.

BString Bds::Digitiser::type

The Digitisers type.


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