r2sonic::sections::A2 Class Reference

An interpreter for Section A2: 16-bit bathy point angles, arbitrarily-spaced (present only during "equi-distant" spacing mode) More...

#include <a2.hpp>

Inheritance diagram for r2sonic::sections::A2:

Collaboration diagram for r2sonic::sections::A2:

Classes
struct	Body
	A datatype represnting the fixed length portion of the A2 message. More...

Public Member Functions
char *	nominalType () const
	returns a chararacter array of length 2 saying the nominal type of the section class
Body *	body () const
	returns a pointer to the fixed size portion of the message (the Body).
BE_u16 *	AngleStep (u16 beam_no) const
	[radians] angle[n] = A2_AngleFirst + (32-bit sum of A2_AngleStep[0] through A2_AngleStep[n]) * A2_ScalingFacto
	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 A2: 16-bit bathy point angles, arbitrarily-spaced (present only during "equi-distant" spacing mode)

Member Function Documentation

AngleStep()

BE_u16 * r2sonic::sections::A2::AngleStep ( u16 beam_no ) const

inline

[radians] angle[n] = A2_AngleFirst + (32-bit sum of A2_AngleStep[0] through A2_AngleStep[n]) * A2_ScalingFacto

Parameters

beam_no

Returns

[radians] angle[n] = A2_AngleFirst + (32-bit sum of A2_AngleStep[0] through A2_AngleStep[n]) * A2_ScalingFacto

body()

Body * r2sonic::sections::A2::body ( ) const

inline

returns a pointer to the fixed size portion of the message (the Body).

Returns

the Body of the Section

nominalType()

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

inlinevirtual

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

Returns

Implements r2sonic::sections::Section.

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