This class defines a calibration setting. More...

#include <BdsD.h>

Inheritance diagram for Bds::Calibration:

Public Member Functions
	Calibration (BUInt32 pid=BUInt32(), BTimeStamp pstartTime=BTimeStamp(), BTimeStamp pendTime=BTimeStamp(), BString pnetwork=BString(), BString pstation=BString(), BString pchannel=BString(), BString psource=BString(), BString pname=BString(), BFloat64 psamplingFrequency=BFloat64(), BFloat64 pcalibrationFrequency=BFloat64(), BFloat64 pcalibrationFactor=BFloat64(), BString pcalibrationUnits=BString(), BFloat64 pdepth=BFloat64(), BFloat64 phorizontalAngle=BFloat64(), BFloat64 pverticalAngle=BFloat64())

BString	getType ()

BError	setMembers (BDictString &members)

BError	setMember (BString name, BString value)

BError	getMembers (BDictString &members)

BError	getMember (BString name, BString &value)

Public Attributes
BUInt32	id
	The ID. More...

BTimeStamp	startTime
	The Start Time. More...

BTimeStamp	endTime
	The End Time. More...

BString	network
	The Network/Organisation Name. More...

BString	station
	The station. More...

BString	channel
	The channel. More...

BString	source
	The source. More...

BString	name
	The Calibrations name, "Main", "Measured". More...

BFloat64	samplingFrequency
	The sample rate used. More...

BFloat64	calibrationFrequency
	The frequency that the CalibrationFactor value is valid for. More...

BFloat64	calibrationFactor
	The scaling value to apply to the data to normalise data to the units. This is a measured value at the calibration frequency. More...

BString	calibrationUnits
	The measurment units. More...

BFloat64	depth
	The depth of the sensor below ground level in meters. More...

BFloat64	horizontalAngle
	The Sensors channel placement horizontal angle in degrees clockwise from north. More...

BFloat64	verticalAngle
	The Sensors channel placement vertical angle in degrees degrees with zero = vertically up. More...

Detailed Description

This class defines a calibration setting.

Constructor & Destructor Documentation

Bds::Calibration::Calibration	(	BUInt32	pid = `BUInt32()`,
		BTimeStamp	pstartTime = `BTimeStamp()`,
		BTimeStamp	pendTime = `BTimeStamp()`,
		BString	pnetwork = `BString()`,
		BString	pstation = `BString()`,
		BString	pchannel = `BString()`,
		BString	psource = `BString()`,
		BString	pname = `BString()`,
		BFloat64	psamplingFrequency = `BFloat64()`,
		BFloat64	pcalibrationFrequency = `BFloat64()`,
		BFloat64	pcalibrationFactor = `BFloat64()`,
		BString	pcalibrationUnits = `BString()`,
		BFloat64	pdepth = `BFloat64()`,
		BFloat64	phorizontalAngle = `BFloat64()`,
		BFloat64	pverticalAngle = `BFloat64()`
	)

Member Function Documentation

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

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

BString Bds::Calibration::getType ( )

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

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

Member Data Documentation

BFloat64 Bds::Calibration::calibrationFactor

The scaling value to apply to the data to normalise data to the units. This is a measured value at the calibration frequency.

BFloat64 Bds::Calibration::calibrationFrequency

The frequency that the CalibrationFactor value is valid for.

BString Bds::Calibration::calibrationUnits

The measurment units.

BString Bds::Calibration::channel

The channel.

BFloat64 Bds::Calibration::depth

The depth of the sensor below ground level in meters.

BTimeStamp Bds::Calibration::endTime

The End Time.

BFloat64 Bds::Calibration::horizontalAngle

The Sensors channel placement horizontal angle in degrees clockwise from north.

BUInt32 Bds::Calibration::id

The ID.

BString Bds::Calibration::name

The Calibrations name, "Main", "Measured".

BString Bds::Calibration::network

The Network/Organisation Name.

BFloat64 Bds::Calibration::samplingFrequency

The sample rate used.

BString Bds::Calibration::source

The source.

BTimeStamp Bds::Calibration::startTime

The Start Time.

BString Bds::Calibration::station

The station.

BFloat64 Bds::Calibration::verticalAngle

The Sensors channel placement vertical angle in degrees degrees with zero = vertically up.

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation