Bds::Channel Class Reference

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

#include <BdsD.h>

Inheritance diagram for Bds::Channel:

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())
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 BObjMember *	getMembers () 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.
BString	network
	The Network Name.
BString	station
	The Stations name.
BString	channel
	The channels name (often as <channelType>_<channelAux>)
BString	channelType
	The channels type (component of station field)
BString	channelAux
	The channels auxilary identifier (component of station field)
BString	dataType
	The Type of data (seismic, seismicUnknown, data, log, unknown, empty)
BString	description
	The channels description.

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. Note that the channelType and channelAux fields are calculated from the channel field and should not be changed. As well as seismic data, a Channel can contain other data types.

Constructor & Destructor Documentation

Channel()

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

getType()

const char * Bds::Channel::getType ( ) const

virtual

Reimplemented from BObj.

setMembers()

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

virtual

Reimplemented from BObj.

setMember()

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

virtual

Reimplemented from BObj.

getMembers()

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

virtual

Reimplemented from BObj.

getMember()

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

virtual

Reimplemented from BObj.

Member Data Documentation

id

BUInt32 Bds::Channel::id

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

startTime

BTimeStamp Bds::Channel::startTime

The Start Time.

endTime

BTimeStamp Bds::Channel::endTime

The End Time the channel was available.

network

BString Bds::Channel::network

The Network Name.

station

BString Bds::Channel::station

The Stations name.

channel

BString Bds::Channel::channel

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

channelType

BString Bds::Channel::channelType

The channels type (component of station field)

channelAux

BString Bds::Channel::channelAux

The channels auxilary identifier (component of station field)

dataType

BString Bds::Channel::dataType

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

description

BString Bds::Channel::description

The channels description.

---

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

• BdsD.h
• BdsD.cc