Bds::Calibration Class Reference

This class defines a calibration setting. More...

#include <BdsD.h>

List of all members.

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(), BFloat64 psamplingFrequency=BFloat64(), BFloat64 pcalibrationFrequency=BFloat64(), BFloat64 pcalibrationFactor=BFloat64(), BString pcalibrationUnits=BString())
BString getType ()
BError setMembers (BDictString &members)
BError getMembers (BDictString &members)

Public Attributes

BUInt32 id
 The ID.
BTimeStamp startTime
 The Start Time.
BTimeStamp endTime
 The End Time.
BString network
 The Network/Organisation Name.
BString station
 The station.
BString channel
 The channel.
BString source
 The source.
BFloat64 samplingFrequency
 The sample rate used.
BFloat64 calibrationFrequency
 The frequency that the CalibrationFactor value is valid for.
BFloat64 calibrationFactor
 The scaling value to apply to the data to normalise to Nanometers. This is a measured value at the calibration frequency and is in Nanometers/Count.
BString calibrationUnits
 The calibration units.


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(),
BFloat64  psamplingFrequency = BFloat64(),
BFloat64  pcalibrationFrequency = BFloat64(),
BFloat64  pcalibrationFactor = BFloat64(),
BString  pcalibrationUnits = BString() 
)


Member Function Documentation

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

BString Bds::Calibration::getType (  ) 

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


Member Data Documentation

BFloat64 Bds::Calibration::calibrationFactor

The scaling value to apply to the data to normalise to Nanometers. This is a measured value at the calibration frequency and is in Nanometers/Count.

BFloat64 Bds::Calibration::calibrationFrequency

The frequency that the CalibrationFactor value is valid for.

BString Bds::Calibration::calibrationUnits

The calibration units.

BString Bds::Calibration::channel

The channel.

BTimeStamp Bds::Calibration::endTime

The End Time.

BUInt32 Bds::Calibration::id

The ID.

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.


The documentation for this class was generated from the following files:
Generated on Mon Dec 14 09:43:53 2009 for BdsApi by  doxygen 1.4.7