r2sonic::sections::R0 Class Reference

An interpreter for Section R0: 16-bit bathy point ranges. More...

#include <r0.hpp>

Inheritance diagram for r2sonic::sections::R0:

Collaboration diagram for r2sonic::sections::R0:

Public Member Functions
char *	nominalType () const
	returns a chararacter array of length 2 saying the nominal type of the section class
BE_f32 *	scaliningFactor () const
	the scaling factor for the intensities reported in
BE_u16 *	range (u16 beam_no) const
	Returns a pointer to the range at beam_no.
u16	getRange (u16 beam_no) const
	Returns the raw range value.
f32	getScaledRange (u16 beam_no) const
	computes the scaled range/2-way travel time for a given 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 R0: 16-bit bathy point ranges.

Member Function Documentation

getRange()

u16 r2sonic::sections::R0::getRange ( u16 beam_no ) const

inline

Returns the raw range value.

Parameters

beam_no

the beam you want the range for

Returns

the raw (unscaled) range value

getScaledRange()

f32 r2sonic::sections::R0::getScaledRange ( u16 beam_no ) const

inline

computes the scaled range/2-way travel time for a given beam

Parameters

beam_no

the beam you want the range for

Returns

the scaled range (seconds two-way) as a machine endian float32

nominalType()

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

inlinevirtual

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

Returns

Implements r2sonic::sections::Section.

range()

BE_u16 * r2sonic::sections::R0::range ( u16 beam_no ) const

inline

Returns a pointer to the range at beam_no.

Parameters

beam_no

the beam you want the range for

Returns

a pointer to the range at beam_no

scaliningFactor()

BE_f32 * r2sonic::sections::R0::scaliningFactor ( ) const

inline

the scaling factor for the intensities reported in

Returns

a pointer to the scaling factor

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/r0.hpp