Account
| BdsApi 2.0.11 |
Bds::Calibration Class Reference
This class defines a calibration setting. More...
#include <BdsD.h>
Inheritance diagram for Bds::Calibration:
Public Member Functions | |
| Calibration (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString station=BString(), BString channel=BString(), BString source=BString(), BString name=BString(), BFloat64 samplingFrequency=0, BFloat64 calibrationFrequency=0, BFloat64 calibrationFactor=0, BString calibrationUnits=BString(), BFloat64 depth=0, BFloat64 horizontalAngle=0, BFloat64 verticalAngle=0) | |
| 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 |
| 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
◆ Calibration()
| Bds::Calibration::Calibration | ( | BUInt32 | id = 0, |
| BTimeStamp | startTime = BTimeStamp(), | ||
| BTimeStamp | endTime = BTimeStamp(), | ||
| BString | network = BString(), | ||
| BString | station = BString(), | ||
| BString | channel = BString(), | ||
| BString | source = BString(), | ||
| BString | name = BString(), | ||
| BFloat64 | samplingFrequency = 0, | ||
| BFloat64 | calibrationFrequency = 0, | ||
| BFloat64 | calibrationFactor = 0, | ||
| BString | calibrationUnits = BString(), | ||
| BFloat64 | depth = 0, | ||
| BFloat64 | horizontalAngle = 0, | ||
| BFloat64 | verticalAngle = 0 | ||
| ) |
Member Function Documentation
◆ getMember()
Reimplemented from BObj.
◆ getMembers()
| virtual |
Reimplemented from BObj.
◆ getType()
| BString Bds::Calibration::getType | ( | ) |
◆ setMember()
◆ setMembers()
| virtual |
Reimplemented from BObj.
Member Data Documentation
◆ calibrationFactor
| 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.
◆ calibrationFrequency
| BFloat64 Bds::Calibration::calibrationFrequency |
The frequency that the CalibrationFactor value is valid for.
◆ calibrationUnits
| BString Bds::Calibration::calibrationUnits |
The measurment units.
◆ channel
| BString Bds::Calibration::channel |
The channel.
◆ depth
| BFloat64 Bds::Calibration::depth |
The depth of the sensor below ground level in meters.
◆ endTime
| BTimeStamp Bds::Calibration::endTime |
The End Time.
◆ horizontalAngle
| BFloat64 Bds::Calibration::horizontalAngle |
The Sensors channel placement horizontal angle in degrees clockwise from north.
◆ id
| BUInt32 Bds::Calibration::id |
The ID.
◆ name
| BString Bds::Calibration::name |
The Calibrations name, "Main", "Measured".
◆ network
| BString Bds::Calibration::network |
The Network/Organisation Name.
◆ samplingFrequency
| BFloat64 Bds::Calibration::samplingFrequency |
The sample rate used.
◆ source
| BString Bds::Calibration::source |
The source.
◆ startTime
| BTimeStamp Bds::Calibration::startTime |
The Start Time.
◆ station
| BString Bds::Calibration::station |
The station.
◆ verticalAngle
| 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:
Generated by
1.8.15