ml::R2SonicWC::WaterColumnM1AndM2Header Class Reference

A structure describing the common data header of an M1_Data and an M2_Data section of a WaterColumn data package. More...

#include <mlWaterColumnStructures.h>

Public Member Functions
	WaterColumnM1AndM2Header ()
	Default constructor. More...
virtual	~WaterColumnM1AndM2Header ()
	Default destructor. More...
virtual std::string	getSectionName () const
	Get name of section as std::string. More...
virtual void	reset ()
	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 Attributes
MLuint16	M1OrM2_SectionName
	'M1' or 'M2'. More...
MLuint16	M1OrM2_SectionSize
	[bytes] size of this entire section More...
MLuint32	M1OrM2_PingNumber
	pings since power-up or reboot More...
MLfloat	M1OrM2_ScalingFactor
	reserved for future use More...
MLuint32	M1OrM2_TotalSamples
	range samples in entire ping, sample rate is H0_RxSampleRate More...
MLuint32	M1OrM2_FirstSample
	first sample of this section More...
MLuint16	M1OrM2_Samples
	number of samples in this section More...
MLuint16	M1OrM2_TotalBeams
	beams (always a multiple of 2) (typically columns in your memory buffer) More...
MLuint16	M1OrM2_FirstBeam
	first beam of this section (always a multiple of 2) More...
MLuint16	M1OrM2_Beams
	number of beams in this section (always a multiple of 2) More...
MLuint32	M1OrM2_reserved0
	reserved for future use More...
MLuint32	M1OrM2_reserved1
	reserved for future use More...

Detailed Description

A structure describing the common data header of an M1_Data and an M2_Data section of a WaterColumn data package.

Definition at line 180 of file mlWaterColumnStructures.h.

Constructor & Destructor Documentation

WaterColumnM1AndM2Header()

ml::R2SonicWC::WaterColumnM1AndM2Header::WaterColumnM1AndM2Header

(

)

Default constructor.

~WaterColumnM1AndM2Header()

virtual ml::R2SonicWC::WaterColumnM1AndM2Header::~WaterColumnM1AndM2Header ( )

virtual

Default destructor.

Member Function Documentation

getAsString()

std::string ml::R2SonicWC::WaterColumnM1AndM2Header::getAsString

(

std::string

prefix

)

const

See WaterColumnDataSet.getAsString for documentation.

getSectionName()

virtual std::string ml::R2SonicWC::WaterColumnM1AndM2Header::getSectionName ( ) const

virtual

Get name of section as std::string.

read()

MLuint64 ml::R2SonicWC::WaterColumnM1AndM2Header::read	(	ByteDataReader &	reader,
		MLuint64 &	fileReadPos
	)

Read section from a file with help of ByteDataReader reader and increase fileReadPos appropriately.

reset()

virtual void ml::R2SonicWC::WaterColumnM1AndM2Header::reset ( )

virtual

Resets all members to construction state.

Member Data Documentation

M1OrM2_Beams

MLuint16 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_Beams

number of beams in this section (always a multiple of 2)

Definition at line 209 of file mlWaterColumnStructures.h.

M1OrM2_FirstBeam

MLuint16 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_FirstBeam

first beam of this section (always a multiple of 2)

Definition at line 208 of file mlWaterColumnStructures.h.

M1OrM2_FirstSample

MLuint32 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_FirstSample

first sample of this section

Definition at line 205 of file mlWaterColumnStructures.h.

M1OrM2_PingNumber

MLuint32 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_PingNumber

pings since power-up or reboot

Definition at line 202 of file mlWaterColumnStructures.h.

M1OrM2_reserved0

MLuint32 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_reserved0

reserved for future use

Definition at line 210 of file mlWaterColumnStructures.h.

M1OrM2_reserved1

MLuint32 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_reserved1

reserved for future use

Definition at line 211 of file mlWaterColumnStructures.h.

M1OrM2_Samples

MLuint16 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_Samples

number of samples in this section

Definition at line 206 of file mlWaterColumnStructures.h.

M1OrM2_ScalingFactor

MLfloat ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_ScalingFactor

reserved for future use

Definition at line 203 of file mlWaterColumnStructures.h.

M1OrM2_SectionName

MLuint16 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_SectionName

'M1' or 'M2'.

Definition at line 200 of file mlWaterColumnStructures.h.

M1OrM2_SectionSize

MLuint16 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_SectionSize

[bytes] size of this entire section

Definition at line 201 of file mlWaterColumnStructures.h.

M1OrM2_TotalBeams

MLuint16 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_TotalBeams

beams (always a multiple of 2) (typically columns in your memory buffer)

Definition at line 207 of file mlWaterColumnStructures.h.

M1OrM2_TotalSamples

MLuint32 ml::R2SonicWC::WaterColumnM1AndM2Header::M1OrM2_TotalSamples

range samples in entire ping, sample rate is H0_RxSampleRate

Definition at line 204 of file mlWaterColumnStructures.h.

---

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

• FMEstable/PCL/Projects/MLPCLR2SonicWCLoader/Sources/mlWaterColumnStructures.h