A structure describing the H0 section of a WaterColumn data package (only one per ping). More...
#include <mlWaterColumnStructures.h>
Public Member Functions | |
| WaterColumnH0 () | |
| Default constructor. More... | |
| ~WaterColumnH0 () override | |
| Default destructor. More... | |
| std::string | getSectionName () const override |
| Get name of section as std::string. More... | |
| std::string | getModelNumber () const |
| Get model number as std::string. More... | |
| std::string | getSerialNumber () const |
| Get serial number as std::string. More... | |
| void | reset () override |
| Resets all members to construction state. More... | |
| MLuint64 | read (ByteDataReader &reader, MLuint64 &fileReadPos) |
| Read section from a file with help of ByteDataReader reader and increase fileReadPos appropriately. More... | |
| std::string | getAsString (std::string prefix) const |
| See WaterColumnDataSet.getAsString for documentation. More... | |
 Public Member Functions inherited from ml::R2SonicWC::WaterColumnSectionBase | |
| WaterColumnSectionBase () | |
| Default constructor. More... | |
| virtual | ~WaterColumnSectionBase () |
| Default destructor. More... | |
Public Attributes | |
| MLuint16 | H0_SectionName |
| 'H0' More... | |
| MLuint16 | H0_SectionSize |
| [bytes] size of this entire section More... | |
| MLuint8 | H0_ModelNumber [12] |
| example "2024", unused chars are nulls More... | |
| MLuint8 | H0_SerialNumber [12] |
| example "100017", unused chars are nulls More... | |
| MLuint32 | H0_TimeSeconds |
| [seconds] ping time relative to 0000 hours 1-Jan-1970, integer part More... | |
| MLuint32 | H0_TimeNanoseconds |
| [nanoseconds] ping time relative to 0000 hours 1-Jan-1970, fraction part More... | |
| MLuint32 | H0_PingNumber |
| pings since power-up or reboot More... | |
| MLfloat | H0_PingPeriod |
| [seconds] time between most recent two pings More... | |
| MLfloat | H0_SoundSpeed |
| [meters per second] More... | |
| MLfloat | H0_Frequency |
| [hertz] sonar center frequency More... | |
| MLfloat | H0_TxPower |
| [dB re 1 uPa at 1 meter] More... | |
| MLfloat | H0_TxPulseWidth |
| [seconds] More... | |
| MLfloat | H0_TxBeamwidthVert |
| [radians] More... | |
| MLfloat | H0_TxBeamwidthHoriz |
| [radians] More... | |
| MLfloat | H0_TxSteeringVert |
| [radians] More... | |
| MLfloat | H0_TxSteeringHoriz |
| [radians] More... | |
| MLuint16 | H0_TxMiscInfo |
| reserved for future use More... | |
| MLint16 | H0_VTX_Plus_Offset |
| [hundredths of a dB] transmit voltage offset at time of ping (divide value by 100 to get dB) More... | |
| MLfloat | H0_RxBandwidth |
| [hertz] More... | |
| MLfloat | H0_RxSampleRate |
| [hertz] sample rate of data acquisition and signal processing More... | |
| MLfloat | H0_RxRange |
| [meters] sonar range setting More... | |
| MLfloat | H0_RxGain |
| [multiply by two for relative dB] More... | |
| MLfloat | H0_RxSpreading |
| [dB (times log range in meters)] More... | |
| MLfloat | H0_RxAbsorption |
| [dB per kilometer] More... | |
| MLfloat | H0_RxMountTilt |
| [radians] More... | |
| MLuint32 | H0_RxMiscInfo |
| reserved for future use More... | |
| MLuint16 | H0_reserved |
| reserved for future use More... | |
| MLuint16 | H0_Beams |
| number of beams More... | |
| Public Attributes inherited from ml::R2SonicWC::WaterColumnSectionBase | |
| MLuint64 | posInFile |
| Location of section in file. More... | |
| MLuint16 | sectionName |
| 'WC', 'H0', 'A1', 'M1', 'M2' More... | |
Detailed Description
A structure describing the H0 section of a WaterColumn data package (only one per ping).
Definition at line 89 of file mlWaterColumnStructures.h.
Constructor & Destructor Documentation
◆ WaterColumnH0()
| ml::R2SonicWC::WaterColumnH0::WaterColumnH0 | ( | ) |
Default constructor.
◆ ~WaterColumnH0()
|
override |
Default destructor.
Member Function Documentation
◆ getAsString()
| std::string ml::R2SonicWC::WaterColumnH0::getAsString | ( | std::string | prefix | ) | const |
See WaterColumnDataSet.getAsString for documentation.
◆ getModelNumber()
| std::string ml::R2SonicWC::WaterColumnH0::getModelNumber | ( | ) | const |
Get model number as std::string.
◆ getSectionName()
|
overridevirtual |
Get name of section as std::string.
Implements ml::R2SonicWC::WaterColumnSectionBase.
◆ getSerialNumber()
| std::string ml::R2SonicWC::WaterColumnH0::getSerialNumber | ( | ) | const |
Get serial number as std::string.
◆ read()
| MLuint64 ml::R2SonicWC::WaterColumnH0::read | ( | ByteDataReader & | reader, |
| MLuint64 & | fileReadPos | ||
| ) |
Read section from a file with help of ByteDataReader reader and increase fileReadPos appropriately.
◆ reset()
|
overridevirtual |
Resets all members to construction state.
Reimplemented from ml::R2SonicWC::WaterColumnSectionBase.
Member Data Documentation
◆ H0_Beams
| MLuint16 ml::R2SonicWC::WaterColumnH0::H0_Beams |
number of beams
Definition at line 142 of file mlWaterColumnStructures.h.
◆ H0_Frequency
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_Frequency |
[hertz] sonar center frequency
Definition at line 124 of file mlWaterColumnStructures.h.
◆ H0_ModelNumber
| MLuint8 ml::R2SonicWC::WaterColumnH0::H0_ModelNumber[12] |
example "2024", unused chars are nulls
Definition at line 117 of file mlWaterColumnStructures.h.
◆ H0_PingNumber
| MLuint32 ml::R2SonicWC::WaterColumnH0::H0_PingNumber |
pings since power-up or reboot
Definition at line 121 of file mlWaterColumnStructures.h.
◆ H0_PingPeriod
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_PingPeriod |
[seconds] time between most recent two pings
Definition at line 122 of file mlWaterColumnStructures.h.
◆ H0_reserved
| MLuint16 ml::R2SonicWC::WaterColumnH0::H0_reserved |
reserved for future use
Definition at line 141 of file mlWaterColumnStructures.h.
◆ H0_RxAbsorption
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_RxAbsorption |
[dB per kilometer]
Definition at line 138 of file mlWaterColumnStructures.h.
◆ H0_RxBandwidth
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_RxBandwidth |
[hertz]
Definition at line 133 of file mlWaterColumnStructures.h.
◆ H0_RxGain
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_RxGain |
[multiply by two for relative dB]
Definition at line 136 of file mlWaterColumnStructures.h.
◆ H0_RxMiscInfo
| MLuint32 ml::R2SonicWC::WaterColumnH0::H0_RxMiscInfo |
reserved for future use
Definition at line 140 of file mlWaterColumnStructures.h.
◆ H0_RxMountTilt
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_RxMountTilt |
[radians]
Definition at line 139 of file mlWaterColumnStructures.h.
◆ H0_RxRange
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_RxRange |
[meters] sonar range setting
Definition at line 135 of file mlWaterColumnStructures.h.
◆ H0_RxSampleRate
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_RxSampleRate |
[hertz] sample rate of data acquisition and signal processing
Definition at line 134 of file mlWaterColumnStructures.h.
◆ H0_RxSpreading
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_RxSpreading |
[dB (times log range in meters)]
Definition at line 137 of file mlWaterColumnStructures.h.
◆ H0_SectionName
| MLuint16 ml::R2SonicWC::WaterColumnH0::H0_SectionName |
'H0'
Definition at line 115 of file mlWaterColumnStructures.h.
◆ H0_SectionSize
| MLuint16 ml::R2SonicWC::WaterColumnH0::H0_SectionSize |
[bytes] size of this entire section
Definition at line 116 of file mlWaterColumnStructures.h.
◆ H0_SerialNumber
| MLuint8 ml::R2SonicWC::WaterColumnH0::H0_SerialNumber[12] |
example "100017", unused chars are nulls
Definition at line 118 of file mlWaterColumnStructures.h.
◆ H0_SoundSpeed
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_SoundSpeed |
[meters per second]
Definition at line 123 of file mlWaterColumnStructures.h.
◆ H0_TimeNanoseconds
| MLuint32 ml::R2SonicWC::WaterColumnH0::H0_TimeNanoseconds |
[nanoseconds] ping time relative to 0000 hours 1-Jan-1970, fraction part
Definition at line 120 of file mlWaterColumnStructures.h.
◆ H0_TimeSeconds
| MLuint32 ml::R2SonicWC::WaterColumnH0::H0_TimeSeconds |
[seconds] ping time relative to 0000 hours 1-Jan-1970, integer part
Definition at line 119 of file mlWaterColumnStructures.h.
◆ H0_TxBeamwidthHoriz
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_TxBeamwidthHoriz |
[radians]
Definition at line 128 of file mlWaterColumnStructures.h.
◆ H0_TxBeamwidthVert
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_TxBeamwidthVert |
[radians]
Definition at line 127 of file mlWaterColumnStructures.h.
◆ H0_TxMiscInfo
| MLuint16 ml::R2SonicWC::WaterColumnH0::H0_TxMiscInfo |
reserved for future use
Definition at line 131 of file mlWaterColumnStructures.h.
◆ H0_TxPower
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_TxPower |
[dB re 1 uPa at 1 meter]
Definition at line 125 of file mlWaterColumnStructures.h.
◆ H0_TxPulseWidth
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_TxPulseWidth |
[seconds]
Definition at line 126 of file mlWaterColumnStructures.h.
◆ H0_TxSteeringHoriz
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_TxSteeringHoriz |
[radians]
Definition at line 130 of file mlWaterColumnStructures.h.
◆ H0_TxSteeringVert
| MLfloat ml::R2SonicWC::WaterColumnH0::H0_TxSteeringVert |
[radians]
Definition at line 129 of file mlWaterColumnStructures.h.
◆ H0_VTX_Plus_Offset
| MLint16 ml::R2SonicWC::WaterColumnH0::H0_VTX_Plus_Offset |
[hundredths of a dB] transmit voltage offset at time of ping (divide value by 100 to get dB)
Definition at line 132 of file mlWaterColumnStructures.h.
The documentation for this class was generated from the following file:
- FMEstable/PCL/Projects/MLPCLR2SonicWCLoader/Sources/mlWaterColumnStructures.h
