Bds::Digitiser Class Reference

This class defines a seismic Digitiser. More...

#include <BdsD.h>

Inheritance diagram for Bds::Digitiser:

Public Member Functions
	Digitiser (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString name=BString(), BString type=BString(), BString serialNumber=BString(), BUInt32 numberChannels=0, BFloat64 baseSamplingFrequency=0, BFloat64 initialSamplingFrequency=0, BFloat64 gain=0, BInt32 shared=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 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
	The ID.
BTimeStamp	startTime
	The Start Time.
BTimeStamp	endTime
	The End Time the channel was available.
BString	name
	The Digitisers name.
BString	type
	The Digitisers type.
BString	serialNumber
	The digitisers's serial number.
BUInt32	numberChannels
	The number of supported channels.
BFloat64	baseSamplingFrequency
	The base sampling frequency.
BFloat64	initialSamplingFrequency
	The initial pre-decimation sampling frequency.
BFloat64	gain
	The overall gain of the digitiser at the manufacturers calibration frequency. (For information only)
BInt32	shared
	This digitiser is shared.

Detailed Description

This class defines a seismic Digitiser.

This just stores information on the seismic instrument's digitiser. Its contents is generally for information only.

Constructor & Destructor Documentation

Digitiser()

Bds::Digitiser::Digitiser	(	BUInt32	id = 0,
		BTimeStamp	startTime = BTimeStamp(),
		BTimeStamp	endTime = BTimeStamp(),
		BString	name = BString(),
		BString	type = BString(),
		BString	serialNumber = BString(),
		BUInt32	numberChannels = 0,
		BFloat64	baseSamplingFrequency = 0,
		BFloat64	initialSamplingFrequency = 0,
		BFloat64	gain = 0,
		BInt32	shared = 0
	)

Member Function Documentation

getType()

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

virtual

Reimplemented from BObj.

setMembers()

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

virtual

Reimplemented from BObj.

setMember()

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

virtual

Reimplemented from BObj.

getMembers()

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

virtual

Reimplemented from BObj.

getMember()

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

virtual

Reimplemented from BObj.

Member Data Documentation

id

BUInt32 Bds::Digitiser::id

The ID.

startTime

BTimeStamp Bds::Digitiser::startTime

The Start Time.

endTime

BTimeStamp Bds::Digitiser::endTime

The End Time the channel was available.

name

BString Bds::Digitiser::name

The Digitisers name.

type

BString Bds::Digitiser::type

The Digitisers type.

serialNumber

BString Bds::Digitiser::serialNumber

The digitisers's serial number.

numberChannels

BUInt32 Bds::Digitiser::numberChannels

The number of supported channels.

baseSamplingFrequency

BFloat64 Bds::Digitiser::baseSamplingFrequency

The base sampling frequency.

initialSamplingFrequency

BFloat64 Bds::Digitiser::initialSamplingFrequency

The initial pre-decimation sampling frequency.

gain

BFloat64 Bds::Digitiser::gain

The overall gain of the digitiser at the manufacturers calibration frequency. (For information only)

shared

BInt32 Bds::Digitiser::shared

This digitiser is shared.

---

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

• BdsD.h
• BdsD.cc