BDS Public
BdsApi 4.0.1
This is the Blacknest BDS API.
Loading...
Searching...
No Matches
Bds::ChannelInstrument Class Reference

This class defines a Channel's instrument. More...

#include <BdsD.h>

Inheritance diagram for Bds::ChannelInstrument:
BObj

Public Member Functions

 ChannelInstrument (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BUInt32 channelId=0, BString source=BString(), BUInt32 digitiserId=0, BUInt32 sensorId=0)
 
const char * getType () const
 
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 BError getMembers (BDictString &members)
 
virtual BError getMember (BString name, BString &value)
 
virtual BError setMembers (BDictString &members)
 
virtual BError setMember (BString name, BString value)
 
virtual void membersPrint () const
 
virtual BString getDebugString ()
 

Public Attributes

BUInt32 id
 Unique ID when stored in a database or for other uses.
 
BTimeStamp startTime
 The Start Time.
 
BTimeStamp endTime
 The End Time the channel was available.
 
BUInt32 channelId
 The channels Id.
 
BString source
 The source.
 
BUInt32 digitiserId
 The Digitiser in use.
 
BUInt32 sensorId
 The sensor in use.
 

Detailed Description

This class defines a Channel's instrument.

This ChannelInstrument links a seismic data channel with a paricular sensor and digitiser. Note that it is possible to share sensors and digitisers between channels if wanted for generic sensor/digitiser definitions. However if particular serial numbers are needed the sensor/digitiser needs to be unique.

Constructor & Destructor Documentation

◆ ChannelInstrument()

Bds::ChannelInstrument::ChannelInstrument ( BUInt32  id = 0,
BTimeStamp  startTime = BTimeStamp(),
BTimeStamp  endTime = BTimeStamp(),
BUInt32  channelId = 0,
BString  source = BString(),
BUInt32  digitiserId = 0,
BUInt32  sensorId = 0 
)

Member Function Documentation

◆ getType()

const char * Bds::ChannelInstrument::getType ( ) const
virtual

Reimplemented from BObj.

◆ setMembers()

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

Reimplemented from BObj.

◆ setMember()

BError Bds::ChannelInstrument::setMember ( BString  name,
BString  value 
)
virtual

Reimplemented from BObj.

◆ getMembers()

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

Reimplemented from BObj.

◆ getMember()

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

Reimplemented from BObj.

Member Data Documentation

◆ id

BUInt32 Bds::ChannelInstrument::id

Unique ID when stored in a database or for other uses.

◆ startTime

BTimeStamp Bds::ChannelInstrument::startTime

The Start Time.

◆ endTime

BTimeStamp Bds::ChannelInstrument::endTime

The End Time the channel was available.

◆ channelId

BUInt32 Bds::ChannelInstrument::channelId

The channels Id.

◆ source

BString Bds::ChannelInstrument::source

The source.

◆ digitiserId

BUInt32 Bds::ChannelInstrument::digitiserId

The Digitiser in use.

◆ sensorId

BUInt32 Bds::ChannelInstrument::sensorId

The sensor in use.


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