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

An interpreter for the "H0" Section which describes general ping information. More...

#include <h0.hpp>

Inheritance diagram for r2sonic::sections::H0:
Collaboration diagram for r2sonic::sections::H0:

Classes

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

Public Member Functions

char * nominalType () const
 returns a chararacter array of length 2 saying the nominal type of the section class
 
const Bodybody () const
 returns a pointer to the fixed size portion of the message (the Body).
 
 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

An interpreter for the "H0" Section which describes general ping information.

Member Function Documentation

◆ body()

const Body * r2sonic::sections::H0::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::H0::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: