Bds::DataChannel Class Reference

This class defines information on a single channel's set of data stored in a file. More...

#include <BdsD.h>

Inheritance diagram for Bds::DataChannel:

Public Member Functions
	DataChannel (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString station=BString(), BString channel=BString(), BString source=BString(), BUInt32 numBlocks=0, BUInt64 numSamples=0, BFloat64 sampleRate=0, BUInt32 sampleFormat=0, BUInt32 dataFileId=0, BUInt32 dataFileChannel=0, BString importFormat=BString(), BString importStream=BString(), BString importFilename=BString(), BTimeStamp importStartTime=BTimeStamp(), BDict< BString > info=BDict< 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.
BString	network
	The Network Name.
BString	station
	The Station name.
BString	channel
	The Channels name.
BString	source
	The Data Source.
BUInt32	numBlocks
	The total number of blocks per channel if known, 0 otherwise.
BUInt64	numSamples
	The total number of samples per channel if known, 0 otherwise.
BFloat64	sampleRate
	The data's sample rate.
BUInt32	sampleFormat
	The data sample format.
BUInt32	dataFileId
	The Data File Id. This links to the particular DataFileInfo where the data is stored.
BUInt32	dataFileChannel
	The Data File Channel number. The channel number within the data file. (1, 2, 3 ...)
BString	importFormat
	The original data format.
BString	importStream
	The real-time data stream the import is from.
BString	importFilename
	The original data file name.
BTimeStamp	importStartTime
	The original import files start time.
BDict< BString >	info
	Extra info on the channel.

Detailed Description

This class defines information on a single channel's set of data stored in a file.

This provides information on actual Sensor data for a channel that is stored in the BDS system. The data will be stored in a particular file perhaps with other data channels (DataFileInfo). When known, information on the channels numBlocks, numSamples and sampleRate will be provided. Generally this information will only be known if a data file has been imported rather than a live real-time data stream. Generally the Sensor data file itself should be interrogated to find the definitive information. The info field provides extra details on the data contents which might come from one of the specific data import formats.

Constructor & Destructor Documentation

DataChannel()

Bds::DataChannel::DataChannel	(	BUInt32	id = 0,
		BTimeStamp	startTime = BTimeStamp(),
		BTimeStamp	endTime = BTimeStamp(),
		BString	network = BString(),
		BString	station = BString(),
		BString	channel = BString(),
		BString	source = BString(),
		BUInt32	numBlocks = 0,
		BUInt64	numSamples = 0,
		BFloat64	sampleRate = 0,
		BUInt32	sampleFormat = 0,
		BUInt32	dataFileId = 0,
		BUInt32	dataFileChannel = 0,
		BString	importFormat = BString(),
		BString	importStream = BString(),
		BString	importFilename = BString(),
		BTimeStamp	importStartTime = BTimeStamp(),
		BDict< BString >	info = BDict<BString >()
	)

Member Function Documentation

getType()

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

virtual

Reimplemented from BObj.

setMembers()

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

virtual

Reimplemented from BObj.

setMember()

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

virtual

Reimplemented from BObj.

getMembers()

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

virtual

Reimplemented from BObj.

getMember()

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

virtual

Reimplemented from BObj.

Member Data Documentation

id

BUInt32 Bds::DataChannel::id

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

startTime

BTimeStamp Bds::DataChannel::startTime

The Start Time.

endTime

BTimeStamp Bds::DataChannel::endTime

The End Time.

network

BString Bds::DataChannel::network

The Network Name.

station

BString Bds::DataChannel::station

The Station name.

channel

BString Bds::DataChannel::channel

The Channels name.

source

BString Bds::DataChannel::source

The Data Source.

numBlocks

BUInt32 Bds::DataChannel::numBlocks

The total number of blocks per channel if known, 0 otherwise.

numSamples

BUInt64 Bds::DataChannel::numSamples

The total number of samples per channel if known, 0 otherwise.

sampleRate

BFloat64 Bds::DataChannel::sampleRate

The data's sample rate.

sampleFormat

BUInt32 Bds::DataChannel::sampleFormat

The data sample format.

dataFileId

BUInt32 Bds::DataChannel::dataFileId

The Data File Id. This links to the particular DataFileInfo where the data is stored.

dataFileChannel

BUInt32 Bds::DataChannel::dataFileChannel

The Data File Channel number. The channel number within the data file. (1, 2, 3 ...)

importFormat

BString Bds::DataChannel::importFormat

The original data format.

importStream

BString Bds::DataChannel::importStream

The real-time data stream the import is from.

importFilename

BString Bds::DataChannel::importFilename

The original data file name.

importStartTime

BTimeStamp Bds::DataChannel::importStartTime

The original import files start time.

info

BDict<BString > Bds::DataChannel::info

Extra info on the channel.

---

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

• BdsD.h
• BdsD.cc