BdsApi  2.2.6
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::Channel Class Reference

This class defines a seismic data Channel. More...

#include <BdsD.h>

Inheritance diagram for Bds::Channel:
BObj

Public Member Functions

 Channel (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString station=BString(), BString channel=BString(), BString channelType=BString(), BString channelAux=BString(), BString dataType=BString(), BString description=BString())
 
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
 Unique ID when stored in a database or for other uses. More...
 
BTimeStamp startTime
 The Start Time. More...
 
BTimeStamp endTime
 The End Time the channel was available. More...
 
BString network
 The Network Name. More...
 
BString station
 The Stations name. More...
 
BString channel
 The channels name (often as <channelType>_<channelAux>) More...
 
BString channelType
 The channels type (component of station field) More...
 
BString channelAux
 The channels auxilary identifier (component of station field) More...
 
BString dataType
 The Type of data (seismic, seismicUnknown, data, log, unknown, empty) More...
 
BString description
 The channels description. More...
 

Detailed Description

This class defines a seismic data Channel.

This class defines a seismic data channel with network:station:channel definitions. The class also splits the channel's name field into channelType and channelAux (channel name is <channelType>_<channelAux> to] allow easy database searches etc. As well as seismic data a channel can contain other data types.

Constructor & Destructor Documentation

Bds::Channel::Channel ( BUInt32  id = 0,
BTimeStamp  startTime = BTimeStamp(),
BTimeStamp  endTime = BTimeStamp(),
BString  network = BString(),
BString  station = BString(),
BString  channel = BString(),
BString  channelType = BString(),
BString  channelAux = BString(),
BString  dataType = BString(),
BString  description = BString() 
)

Member Function Documentation

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

Reimplemented from BObj.

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

Reimplemented from BObj.

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

Reimplemented from BObj.

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

Reimplemented from BObj.

Member Data Documentation

BString Bds::Channel::channel

The channels name (often as <channelType>_<channelAux>)

BString Bds::Channel::channelAux

The channels auxilary identifier (component of station field)

BString Bds::Channel::channelType

The channels type (component of station field)

BString Bds::Channel::dataType

The Type of data (seismic, seismicUnknown, data, log, unknown, empty)

BString Bds::Channel::description

The channels description.

BTimeStamp Bds::Channel::endTime

The End Time the channel was available.

BUInt32 Bds::Channel::id

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

BString Bds::Channel::network

The Network Name.

BTimeStamp Bds::Channel::startTime

The Start Time.

BString Bds::Channel::station

The Stations name.


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