ROS2Sonic  0.2.0
A ROS2 driver for R2Sonic MBES
Loading...
Searching...
No Matches
r2sonic::sections::G1 Class Reference

simple straight-line depth gates More...

#include <g1.hpp>

Inheritance diagram for r2sonic::sections::G1:
Collaboration diagram for r2sonic::sections::G1:

Classes

struct  Gate
 A structure representing the 2 byte gate information. More...
 

Public Member Functions

char * nominalType () const
 returns a chararacter array of length 2 saying the nominal type of the section class
 
BE_f32ScalingFactor () const
 Returns a poniter to the raw scaling factor.
 
Gategate (u16 beam_no)
 Get's the Gate at 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
 
SectionInfoinfo () 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

simple straight-line depth gates

Member Function Documentation

◆ gate()

Gate * r2sonic::sections::G1::gate ( u16 beam_no)
inline

Get's the Gate at the specified beam.

Parameters
beam_no
Returns
a pointer to the unscaled Gate

◆ nominalType()

char * r2sonic::sections::G1::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::G1::ScalingFactor ( ) const
inline

Returns a poniter to the raw scaling factor.

Returns
a poniter to the raw 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: