Bds::DataChannel Class Reference

This class defines information on a single channels set of data. 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 importFilename=BString(), BTimeStamp importStartTime=BTimeStamp(), BDict< BString > info=BDict< 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 BObjMember *	getMembers () 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. More...
BString	network
	The Network Name. More...
BString	station
	The Station name. More...
BString	channel
	The Channels name. More...
BString	source
	The Data Source. More...
BUInt32	numBlocks
	The total number of blocks per channel if known, 0 otherwise. More...
BUInt64	numSamples
	The total number of samples per channel if known, 0 otherwise. More...
BFloat64	sampleRate
	The data's sample rate. More...
BUInt32	sampleFormat
	The data sample format. More...
BUInt32	dataFileId
	The Data File Id. More...
BUInt32	dataFileChannel
	The Data File Channel number. More...
BString	importFormat
	The original data format. More...
BString	importFilename
	The original data file name. More...
BTimeStamp	importStartTime
	The original import files start time. More...
BDict< BString >	info
	Extra info on the channel. More...

Detailed Description

This class defines information on a single channels set of data.

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	importFilename = BString(),
		BTimeStamp	importStartTime = BTimeStamp(),
		BDict< BString >	info = BDict<BString >()
	)

Member Function Documentation

getMember()

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

virtual

Reimplemented from BObj.

getMembers()

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

virtual

Reimplemented from BObj.

getType()

BString Bds::DataChannel::getType

(

)

setMember()

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

virtual

Reimplemented from BObj.

setMembers()

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

virtual

Reimplemented from BObj.

Member Data Documentation

channel

BString Bds::DataChannel::channel

The Channels name.

dataFileChannel

BUInt32 Bds::DataChannel::dataFileChannel

The Data File Channel number.

dataFileId

BUInt32 Bds::DataChannel::dataFileId

The Data File Id.

endTime

BTimeStamp Bds::DataChannel::endTime

The End Time.

id

BUInt32 Bds::DataChannel::id

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

importFilename

BString Bds::DataChannel::importFilename

The original data file name.

importFormat

BString Bds::DataChannel::importFormat

The original data format.

importStartTime

BTimeStamp Bds::DataChannel::importStartTime

The original import files start time.

info

BDict<BString > Bds::DataChannel::info

Extra info on the channel.

network

BString Bds::DataChannel::network

The Network Name.

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.

sampleFormat

BUInt32 Bds::DataChannel::sampleFormat

The data sample format.

sampleRate

BFloat64 Bds::DataChannel::sampleRate

The data's sample rate.

source

BString Bds::DataChannel::source

The Data Source.

startTime

BTimeStamp Bds::DataChannel::startTime

The Start Time.

station

BString Bds::DataChannel::station

The Station name.

---

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

• BdsD.h
• BdsD.cc