Class describing a introducing data packet of a WaterColumn data package. More...

#include <mlWaterColumnStructures.h>

Inheritance diagram for ml::R2SonicWC::WaterColumnPacket:

Public Member Functions
	WaterColumnPacket ()
	Default constructor.

	~WaterColumnPacket () override
	Default destructor.

std::string	getSectionName () const override
	Get name of section as std::string.

void	reset () override
	Resets all members to construction state.

MLuint64	read (ByteDataReader &reader, MLuint64 &fileReadPos)
	Read section from a file with help of ByteDataReader reader and increase fileReadPos appropriately.

std::string	getAsString (std::string prefix="") const
	See WaterColumnDataSet.getAsString for documentation.

Public Member Functions inherited from ml::R2SonicWC::WaterColumnSectionBase
	WaterColumnSectionBase ()
	Default constructor.

virtual	~WaterColumnSectionBase ()
	Default destructor.

	WaterColumnSectionBase (const WaterColumnSectionBase &)=default
	Default copy constructor.

WaterColumnSectionBase &	operator= (const WaterColumnSectionBase &)=default
	Default assignment operator.

Public Attributes
MLuint32	PacketName
	'WCD0'

MLuint32	PacketSize
	[bytes] size of this entire packet

MLuint32	DataStreamID
	reserved for future use

Public Attributes inherited from ml::R2SonicWC::WaterColumnSectionBase
MLuint64	posInFile
	Location of section in file.

MLuint16	sectionName
	'WC', 'H0', 'A1', 'M1', 'M2'

Detailed Description

Class describing a introducing data packet of a WaterColumn data package.

Definition at line 300 of file mlWaterColumnStructures.h.

Constructor & Destructor Documentation

◆ WaterColumnPacket()

ml::R2SonicWC::WaterColumnPacket::WaterColumnPacket ( )

Default constructor.

◆ ~WaterColumnPacket()

ml::R2SonicWC::WaterColumnPacket::~WaterColumnPacket ( )

override

Default destructor.

Member Function Documentation

◆ getAsString()

std::string ml::R2SonicWC::WaterColumnPacket::getAsString ( std::string prefix = "" ) const

See WaterColumnDataSet.getAsString for documentation.

◆ getSectionName()

std::string ml::R2SonicWC::WaterColumnPacket::getSectionName ( ) const

overridevirtual

Get name of section as std::string.

Implements ml::R2SonicWC::WaterColumnSectionBase.

◆ read()

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

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

◆ reset()

void ml::R2SonicWC::WaterColumnPacket::reset ( )

overridevirtual

Resets all members to construction state.

Reimplemented from ml::R2SonicWC::WaterColumnSectionBase.

Member Data Documentation

◆ DataStreamID

MLuint32 ml::R2SonicWC::WaterColumnPacket::DataStreamID

reserved for future use

Definition at line 322 of file mlWaterColumnStructures.h.

◆ PacketName

MLuint32 ml::R2SonicWC::WaterColumnPacket::PacketName

'WCD0'

Definition at line 320 of file mlWaterColumnStructures.h.

◆ PacketSize

MLuint32 ml::R2SonicWC::WaterColumnPacket::PacketSize

[bytes] size of this entire packet

Definition at line 321 of file mlWaterColumnStructures.h.

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

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

Public Member Functions

Public Attributes