Class describing the common data header of a WaterColumn data package. More...

#include <mlWaterColumnStructures.h>

Public Member Functions
	WaterColumnDataSet ()
	Default constructor. More...

virtual	~WaterColumnDataSet ()
	Default destructor. More...

void	setWorkingMemoryHint (MLuint64 numBytes)
	Set working memory hints in bytes. More...

MLuint64	getWorkingMemoryHint () const
	Set working memory hints in bytes. More...

bool	isValid () const
	Returns true if the file looks valid, otherwise false. More...

virtual void	reset ()
	Resets all members to construction state. More...

MLuint64	read (R2SonicWCLoader &reader, MLuint64 &fileReadPos, PCLR2SonicWCLoader &updateObject)
	Read all data section from a file with help of ByteDataReader reader and increase fileReadPos appropriately. More...

std::string	getAsString (const MLint maxSections=-1, const MLint maxBeams=-1, const MLint maxSamplesPerBeam=-1, std::string prefix="", const std::string &sep=" ", const bool showFirstOfEachPacketTypeOnly=false) const
	Convert content to a human readable string with the prefix prefix before all lines and separator sep between all subcomponents. More...

Public Attributes
std::list< WaterColumnSectionBase * >	sectionList
	List of all packets, must be deallocated. More...

std::string	unknownSection
	Intro of first found unknown section. More...

size_t	numWCD0Sections
	Set to number of found WCD0 sections after initialization, otherwise 0. More...

size_t	numH0Sections
	Set to number of found H0 sections after initialization, otherwise 0. More...

size_t	numA1Sections
	Set to number of found A1 sections after initialization, otherwise 0. More...

size_t	numM1Sections
	Set to number of found M1 sections after initialization, otherwise 0. More...

size_t	numM2Sections
	Set to number of found M2 sections after initialization, otherwise 0. More...

size_t	numOrphanedMSections
	Set to number of found M sections where no WCD0, H0 or A1 section is found, otherwise 0. More...

size_t	numUnknownSections
	Set to number of found unknown sections after initialization, otherwise 0. More...

size_t	numSamplesInFile
	Set to number of samples in entire file, otherwise 0. More...

size_t	numTotalPingNumbers
	Set to the number of different ping numbers in file including those which have missing or invalid H0, A1, WCD0, and M sections. More...

size_t	numValidPingNumbers
	Set to the number of different ping numbers in file which have valid H0, A1, WCD0, and M sections. More...

std::string	mostRecentSectionIntro
	The first two chars of the most recently read section or "" otherwise. More...

std::map< MLuint32, WaterColumnDataSetPing >	allPingSections
	A map allowing the direct access to all sections belonging to a specific ping number. More...

std::map< MLuint32, WaterColumnDataSetPing >	validPingSections
	The subset of pings of allPingSections which contains only those ones where WCD0, H0, and A1 sections are together and have at least on M1 or M2 section. More...

std::vector< MLuint32 >	allPingNumbers
	An array containing all ping numbers found in file, and sorted. More...

Simple pointers not to be deleted.
WaterColumnPacket *	firstWaterColumnPacket
	Set to the first found waterColumnPacket, nullptr otherwise. More...

WaterColumnH0 *	firstH0Section
	Set to the first found H0 section, nullptr otherwise. More...

WaterColumnA1 *	firstA1Section
	Set to the first found A1 section, nullptr otherwise. More...

WaterColumnM1OrM2 *	firstM1Section
	Set to the first found M1 section, nullptr otherwise. More...

WaterColumnM1OrM2 *	firstM2Section
	Set to the first found M2 section, nullptr otherwise. More...

WaterColumnM1OrM2 *	firstMxSection
	Set to the first found M1 or M2 section, nullptr otherwise. More...

WaterColumnSectionBase *	mostRecentSection
	Set most recently read section or nullptr otherwise. More...

Protected Attributes
MLuint64	_workingMemoryHint
	Working memory hint in bytes. More...

Detailed Description

Class describing the common data header of a WaterColumn data package.

Definition at line 341 of file mlWaterColumnStructures.h.

Constructor & Destructor Documentation

◆ WaterColumnDataSet()

ml::R2SonicWC::WaterColumnDataSet::WaterColumnDataSet ( )

Default constructor.

◆ ~WaterColumnDataSet()

virtual ml::R2SonicWC::WaterColumnDataSet::~WaterColumnDataSet ( )

virtual

Default destructor.

Member Function Documentation

◆ getAsString()

std::string ml::R2SonicWC::WaterColumnDataSet::getAsString	(	const MLint	maxSections = `-1`,
		const MLint	maxBeams = `-1`,
		const MLint	maxSamplesPerBeam = `-1`,
		std::string	prefix = `""`,
		const std::string &	sep = `" "`,
		const bool	showFirstOfEachPacketTypeOnly = `false`
	)		const

Convert content to a human readable string with the prefix prefix before all lines and separator sep between all subcomponents.

If a binary tag is displayed then the number of shown values is controlled with maxNumBinaryEntries; if there are more then "..." is displayed instead. If a binary tag of type Uint16 which might be a unicoded string then the number of shown values is controlled with maxNumStringEntries; if there are more then "..." is displayed instead.

Parameters

maxSections	is the maximum number of sections to dump (all if smaller 0)
maxBeams	is the maximum number of beams to dump (all if smaller 0)
maxSamplesPerBeam	is the maximum number of samples of dumped beams to dump (all if smaller 0)
prefix	A string added at begin of each line.
sep	A separator string to be printed between values printed in one line.
showFirstOfEachPacketTypeOnly	If enabled then only the first of each section type is shown (if available); in enabled case the maxPackets value is ignored (default is false).

Returns: the human readable content dump string.

◆ getWorkingMemoryHint()

MLuint64 ml::R2SonicWC::WaterColumnDataSet::getWorkingMemoryHint ( ) const

Set working memory hints in bytes.

◆ isValid()

bool ml::R2SonicWC::WaterColumnDataSet::isValid ( ) const

Returns true if the file looks valid, otherwise false.

A file is considered valid if each section type (WCD0, H0, A1, one M1/M2) appears at least once.

◆ read()

MLuint64 ml::R2SonicWC::WaterColumnDataSet::read	(	R2SonicWCLoader &	reader,
		MLuint64 &	fileReadPos,
		PCLR2SonicWCLoader &	updateObject
	)

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

When given as non-nullptr pointer then updateCB is called with some information, percentage between 0 and 1 and given user data pointer.

◆ reset()

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

virtual

Resets all members to construction state.

◆ setWorkingMemoryHint()

void ml::R2SonicWC::WaterColumnDataSet::setWorkingMemoryHint ( MLuint64 numBytes )

Set working memory hints in bytes.

Member Data Documentation

◆ _workingMemoryHint

MLuint64 ml::R2SonicWC::WaterColumnDataSet::_workingMemoryHint

protected

Working memory hint in bytes.

Definition at line 401 of file mlWaterColumnStructures.h.

◆ allPingNumbers

std::vector<MLuint32> ml::R2SonicWC::WaterColumnDataSet::allPingNumbers

An array containing all ping numbers found in file, and sorted.

Allows indexed and sorted access over ping numbers to the related ping data.

Definition at line 397 of file mlWaterColumnStructures.h.

◆ allPingSections

std::map<MLuint32, WaterColumnDataSetPing> ml::R2SonicWC::WaterColumnDataSet::allPingSections

A map allowing the direct access to all sections belonging to a specific ping number.

Definition at line 389 of file mlWaterColumnStructures.h.

◆ firstA1Section

WaterColumnA1* ml::R2SonicWC::WaterColumnDataSet::firstA1Section

Set to the first found A1 section, nullptr otherwise.

Definition at line 380 of file mlWaterColumnStructures.h.

◆ firstH0Section

WaterColumnH0* ml::R2SonicWC::WaterColumnDataSet::firstH0Section

Set to the first found H0 section, nullptr otherwise.

Definition at line 379 of file mlWaterColumnStructures.h.

◆ firstM1Section

WaterColumnM1OrM2* ml::R2SonicWC::WaterColumnDataSet::firstM1Section

Set to the first found M1 section, nullptr otherwise.

Definition at line 381 of file mlWaterColumnStructures.h.

◆ firstM2Section

WaterColumnM1OrM2* ml::R2SonicWC::WaterColumnDataSet::firstM2Section

Set to the first found M2 section, nullptr otherwise.

Definition at line 382 of file mlWaterColumnStructures.h.

◆ firstMxSection

WaterColumnM1OrM2* ml::R2SonicWC::WaterColumnDataSet::firstMxSection

Set to the first found M1 or M2 section, nullptr otherwise.

Definition at line 383 of file mlWaterColumnStructures.h.

◆ firstWaterColumnPacket

WaterColumnPacket* ml::R2SonicWC::WaterColumnDataSet::firstWaterColumnPacket

Set to the first found waterColumnPacket, nullptr otherwise.

Definition at line 378 of file mlWaterColumnStructures.h.

◆ mostRecentSection

WaterColumnSectionBase* ml::R2SonicWC::WaterColumnDataSet::mostRecentSection

Set most recently read section or nullptr otherwise.

Definition at line 384 of file mlWaterColumnStructures.h.

◆ mostRecentSectionIntro

std::string ml::R2SonicWC::WaterColumnDataSet::mostRecentSectionIntro

The first two chars of the most recently read section or "" otherwise.

Definition at line 386 of file mlWaterColumnStructures.h.

◆ numA1Sections

size_t ml::R2SonicWC::WaterColumnDataSet::numA1Sections

Set to number of found A1 sections after initialization, otherwise 0.

Definition at line 367 of file mlWaterColumnStructures.h.

◆ numH0Sections

size_t ml::R2SonicWC::WaterColumnDataSet::numH0Sections

Set to number of found H0 sections after initialization, otherwise 0.

Definition at line 366 of file mlWaterColumnStructures.h.

◆ numM1Sections

size_t ml::R2SonicWC::WaterColumnDataSet::numM1Sections

Set to number of found M1 sections after initialization, otherwise 0.

Definition at line 368 of file mlWaterColumnStructures.h.

◆ numM2Sections

size_t ml::R2SonicWC::WaterColumnDataSet::numM2Sections

Set to number of found M2 sections after initialization, otherwise 0.

Definition at line 369 of file mlWaterColumnStructures.h.

◆ numOrphanedMSections

size_t ml::R2SonicWC::WaterColumnDataSet::numOrphanedMSections

Set to number of found M sections where no WCD0, H0 or A1 section is found, otherwise 0.

Definition at line 370 of file mlWaterColumnStructures.h.

◆ numSamplesInFile

size_t ml::R2SonicWC::WaterColumnDataSet::numSamplesInFile

Set to number of samples in entire file, otherwise 0.

Definition at line 372 of file mlWaterColumnStructures.h.

◆ numTotalPingNumbers

size_t ml::R2SonicWC::WaterColumnDataSet::numTotalPingNumbers

Set to the number of different ping numbers in file including those which have missing or invalid H0, A1, WCD0, and M sections.

Definition at line 373 of file mlWaterColumnStructures.h.

◆ numUnknownSections

size_t ml::R2SonicWC::WaterColumnDataSet::numUnknownSections

Set to number of found unknown sections after initialization, otherwise 0.

Definition at line 371 of file mlWaterColumnStructures.h.

◆ numValidPingNumbers

size_t ml::R2SonicWC::WaterColumnDataSet::numValidPingNumbers

Set to the number of different ping numbers in file which have valid H0, A1, WCD0, and M sections.

Definition at line 374 of file mlWaterColumnStructures.h.

◆ numWCD0Sections

size_t ml::R2SonicWC::WaterColumnDataSet::numWCD0Sections

Set to number of found WCD0 sections after initialization, otherwise 0.

Definition at line 365 of file mlWaterColumnStructures.h.

◆ sectionList

std::list<WaterColumnSectionBase*> ml::R2SonicWC::WaterColumnDataSet::sectionList

List of all packets, must be deallocated.

Definition at line 360 of file mlWaterColumnStructures.h.

◆ unknownSection

std::string ml::R2SonicWC::WaterColumnDataSet::unknownSection

Intro of first found unknown section.

Definition at line 363 of file mlWaterColumnStructures.h.

◆ validPingSections

std::map<MLuint32, WaterColumnDataSetPing> ml::R2SonicWC::WaterColumnDataSet::validPingSections

The subset of pings of allPingSections which contains only those ones where WCD0, H0, and A1 sections are together and have at least on M1 or M2 section.

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

Protected Attributes