A structure describing the A1 section of a WaterColumn data package containing float beam angles, arbitrarily-spaced (only one per ping). More...

#include <mlWaterColumnStructures.h>

Inheritance diagram for ml::R2SonicWC::WaterColumnA1:

Public Member Functions
	WaterColumnA1 ()
	Default constructor.

	~WaterColumnA1 () 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, size_t numH0Beams)
	Read section from a file with help of ByteDataReader reader and increase fileReadPos appropriately.

std::string	getAsString (std::string prefix, const std::string &sep=" ", const MLint maxBeams=-1) 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
std::vector< MLfloat >	A1_BeamAngle
	size=[H0_Beams]; [radians] angle of beam relative to array centerline, ordered from port to starboard, first angle < last angle

MLuint16	A1_SectionName
	'A1'

MLuint16	A1_SectionSize
	[bytes] size of this entire section

MLfloat	A1_MoreInfo [6]
	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

A structure describing the A1 section of a WaterColumn data package containing float beam angles, arbitrarily-spaced (only one per ping).

Definition at line 155 of file mlWaterColumnStructures.h.

Constructor & Destructor Documentation

◆ WaterColumnA1()

ml::R2SonicWC::WaterColumnA1::WaterColumnA1 ( )

Default constructor.

◆ ~WaterColumnA1()

ml::R2SonicWC::WaterColumnA1::~WaterColumnA1 ( )

override

Default destructor.

Member Function Documentation

◆ getAsString()

std::string ml::R2SonicWC::WaterColumnA1::getAsString	(	std::string	prefix,
		const std::string &	sep = `" "`,
		const MLint	maxBeams = `-1`
	)		const

See WaterColumnDataSet.getAsString for documentation.

◆ getSectionName()

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

overridevirtual

Get name of section as std::string.

Implements ml::R2SonicWC::WaterColumnSectionBase.

◆ read()

MLuint64 ml::R2SonicWC::WaterColumnA1::read	(	ByteDataReader &	reader,
		MLuint64 &	fileReadPos,
		size_t	numH0Beams
	)

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

◆ reset()

void ml::R2SonicWC::WaterColumnA1::reset ( )

overridevirtual

Resets all members to construction state.

Reimplemented from ml::R2SonicWC::WaterColumnSectionBase.

Member Data Documentation

◆ A1_BeamAngle

std::vector<MLfloat> ml::R2SonicWC::WaterColumnA1::A1_BeamAngle

size=[H0_Beams]; [radians] angle of beam relative to array centerline, ordered from port to starboard, first angle < last angle

Definition at line 177 of file mlWaterColumnStructures.h.

◆ A1_MoreInfo

MLfloat ml::R2SonicWC::WaterColumnA1::A1_MoreInfo[6]

reserved for future use

Definition at line 180 of file mlWaterColumnStructures.h.

◆ A1_SectionName

MLuint16 ml::R2SonicWC::WaterColumnA1::A1_SectionName

'A1'

Definition at line 178 of file mlWaterColumnStructures.h.

◆ A1_SectionSize

MLuint16 ml::R2SonicWC::WaterColumnA1::A1_SectionSize

[bytes] size of this entire section

Definition at line 179 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