r2sonic::packets::BTH0 Class Reference

An interpreter class that represents the Bathmetry Data (BHT0) packet. More...

#include <bth0.hpp>

Inheritance diagram for r2sonic::packets::BTH0:

Collaboration diagram for r2sonic::packets::BTH0:

Public Member Functions
sections::H0	h0 () const
	Gets the sections::H0 Section associated with the BTH0 packet.
sections::R0	r0 () const
	Gets the sections::R0 Section associated with the BTH0 packet.
sections::A0	a0 () const
	Requests the OPTIONAL section sections::A0.
sections::A2	a2 () const
	Requests the OPTIONAL section sections::A2.
sections::I1	i1 () const
	Requests the OPTIONAL section sections::I1.
sections::G0	g0 () const
	Gets the sections::G0 Section associated with the BTH0 packet.
sections::G1	g1 () const
	Requests the OPTIONAL section sections::G1.
sections::Q0	q0 () const
	Gets the sections::Q0 Section associated with the BTH0 packet.
	Packet (char *start_bit)
	Constructor.
Public Member Functions inherited from r2sonic::packets::Packet
	Packet (char *start_bit)
	Constructor.
const sections::MiniHeader *	miniHeader () const
	returns a pointer to the miniHeader
char *	startBit () const
	returns a pointer to the start bit used to define the packet
u16	getSize () const
	gets the size of the entire DataFormat Packet reported by the MiniHeader
char *	end () const
	end returns a pointer to one bit beyond the current DataFormat Packet (the first bit of the next Packet)
char *	SectionsStartBit () const
	Returns the starting bit of the data sections of the packet (just after the mini header)
bool	isType () const
	Determines if the packet can be instantiated given the current data in the buffer.

Protected Member Functions
char *	nominalType () const
Protected Member Functions inherited from r2sonic::packets::Packet
void	typeErrorCheck () const

Detailed Description

An interpreter class that represents the Bathmetry Data (BHT0) packet.

This class has accessors which will return a pointer to each sub-section of the received packet.

Note

Some packets are optional. See the member function defitions for details

Member Function Documentation

a0()

sections::A0 r2sonic::packets::BTH0::a0 ( ) const

inline

Requests the OPTIONAL section sections::A0.

Note

This is an optional parameter present only during "equi-angle" spacing mode. make sure sections::A0::exists() == true before accessing

Returns

The Packets's sections::A0 Section

Exceptions

std::out_of_range

if Section doesn't exist

a2()

sections::A2 r2sonic::packets::BTH0::a2 ( ) const

inline

Requests the OPTIONAL section sections::A2.

Note

This is an optional parameter present only during "equi-distant" spacing mode. make sure sections::A2::exists() == true before accessing

Returns

The Packets's sections::A2 Section

Exceptions

std::out_of_range

if Section doesn't exist

g0()

sections::G0 r2sonic::packets::BTH0::g0 ( ) const

inline

Gets the sections::G0 Section associated with the BTH0 packet.

Returns

The Packet's sections::G0 Section;

g1()

sections::G1 r2sonic::packets::BTH0::g1 ( ) const

inline

Requests the OPTIONAL section sections::G1.

Note

This is an optional parameter present only if enabled on the sonar. make sure sections::G1::exists() == true before accessing

Returns

The Packets's sections::G1 Section

Exceptions

std::out_of_range

if Section doesn't exist

h0()

sections::H0 r2sonic::packets::BTH0::h0 ( ) const

inline

Gets the sections::H0 Section associated with the BTH0 packet.

Returns

The Packet's sections::H0 Section;

i1()

sections::I1 r2sonic::packets::BTH0::i1 ( ) const

inline

Requests the OPTIONAL section sections::I1.

Note

This is an optional parameter present only if intensity is enabled on the sonar. make sure sections::I1::exists() == true before accessing

Returns

The Packets's sections::I1 Section

Exceptions

std::out_of_range

if Section doesn't exist

nominalType()

char * r2sonic::packets::BTH0::nominalType ( ) const

inlineprotectedvirtual

Implements r2sonic::packets::Packet.

Packet()

r2sonic::packets::Packet::Packet ( char * start_bit )

inline

Constructor.

Parameters

the	start bit of the datagram you want to read

q0()

sections::Q0 r2sonic::packets::BTH0::q0 ( ) const

inline

Gets the sections::Q0 Section associated with the BTH0 packet.

Returns

The Packet's sections::Q0 Section;

r0()

sections::R0 r2sonic::packets::BTH0::r0 ( ) const

inline

Gets the sections::R0 Section associated with the BTH0 packet.

Returns

The Packet's sections::R0 Section;

---

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

• r2sonic/include/r2sonic/packets/bth0.hpp