r2sonic::sections::I1 Class Reference

An interpreter for Section I1: 16-bit bathy intensity (present only if enabled) More...

#include <i1.hpp>

Inheritance diagram for r2sonic::sections::I1:

Collaboration diagram for r2sonic::sections::I1:

Public Member Functions
char *	nominalType () const
	returns a chararacter array of length 2 saying the nominal type of the section class
BE_f32 *	ScalingFactor () const
BE_u16 *	Intensity (u16 beam_no) const
	Returns the raw intensity [micropascals] intensity[n] = I1_Intensity[n]) * I1_ScalingFacto.
f32	getScaledIntensity (u16 beam_no) const
	Coputes the scaled intesity for the specified beam.
	Section (char *start_bit)
	Section.
Public Member Functions inherited from r2sonic::sections::Section
	Section (char *start_bit)
	Section.
bool	isType () const
	Return true if your type matches the header.
bool	exists () const
	states weather that section exists where expected
u16	getSize () const
	getSize returns the size of the message in system-endian order
SectionInfo *	info () const
	info gets the reference to the common section info
char *	end () const
	end returns a pointer to one bit beyond the current section (the first bit of the next seciton)

Additional Inherited Members
Protected Member Functions inherited from r2sonic::sections::Section
void	existanceErrorCheck () const
Protected Attributes inherited from r2sonic::sections::Section
char *	start_bit_
	a pointer to the first bit in the message

Detailed Description

An interpreter for Section I1: 16-bit bathy intensity (present only if enabled)

Member Function Documentation

getScaledIntensity()

f32 r2sonic::sections::I1::getScaledIntensity ( u16 beam_no ) const

inline

Coputes the scaled intesity for the specified beam.

Parameters

beam_no

the beam you want the scaled intesity for

Returns

the scaled intensity at beam: beam_no

Intensity()

BE_u16 * r2sonic::sections::I1::Intensity ( u16 beam_no ) const

inline

Returns the raw intensity [micropascals] intensity[n] = I1_Intensity[n]) * I1_ScalingFacto.

Parameters

beam_no

the beam you want the raw intensity for

Returns

the raw intensity at beam_no

nominalType()

char * r2sonic::sections::I1::nominalType ( ) const

inlinevirtual

returns a chararacter array of length 2 saying the nominal type of the section class

Returns

Implements r2sonic::sections::Section.

ScalingFactor()

BE_f32 * r2sonic::sections::I1::ScalingFactor ( ) const

inline

Section()

r2sonic::sections::Section::Section ( char * start_bit )

inline

Section.

Parameters

start_bit

---

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

• r2sonic/include/r2sonic/sections/i1.hpp