DUNE::Utils::Codecs::CodedReference Struct Reference

Detailed Description

This struct has methods to encode/decode several Reference IMC messages into single UamTxFrame/UamRxFrame IMC messages.

Static Public Member Functions
static void	encodeById (const IMC::Reference *msg, IMC::UamTxFrame *frame, uint8_t id)
static IMC::Message *	decodeById (const IMC::UamRxFrame *frame, uint8_t id)
static size_t	getPayloadSize (uint8_t num)

Static Public Attributes
static const uint8_t	c_id

Member Function Documentation

static IMC::Message* DUNE::Utils::Codecs::CodedReference::decodeById ( const IMC::UamRxFrame *  frame, uint8_t  id  )

inlinestatic

Decode an UamRxFrame by System ID to retrieve a Reference message.

Parameters

[in]	frame	UamRxFrame pointer.
[in]	id	System ID.

Returns

IMC message.

References DUNE::IMC::UamRxFrame::data.

static void DUNE::Utils::Codecs::CodedReference::encodeById ( const IMC::Reference *  msg, IMC::UamTxFrame *  frame, uint8_t  id  )

inlinestatic

Encode a Reference message to a UamTxFrame by System ID.

Parameters

[in]	msg	Reference pointer.
[out]	frame	UamTxFrame pointer.
[in]	id	System ID.

Returns

true if message successfully decoded, false otherwise.

References DUNE::IMC::UamTxFrame::data.

static size_t DUNE::Utils::Codecs::CodedReference::getPayloadSize ( uint8_t  num )

inlinestatic

Get payload size by number of Reference messages.

Returns

size of payload.

References c_id, DUNE::IMC::UamTxFrame::data, DUNE::IMC::UamRxFrame::data, DUNE::IMC::deserialize(), DUNE::IMC::Reference::FLAG_LOCATION, DUNE::IMC::Reference::FLAG_RADIUS, DUNE::IMC::Reference::FLAG_Z, DUNE::IMC::Reference::flags, DUNE::IMC::Message::getDestination(), DUNE::IMC::Reference::lat, DUNE::IMC::Reference::lon, DUNE::IMC::Reference::radius, DUNE::IMC::serialize(), DUNE::IMC::Message::setDestination(), DUNE::IMC::DesiredZ::value, DUNE::IMC::Reference::z, and DUNE::IMC::Z_DEPTH.

Member Data Documentation

const uint8_t DUNE::Utils::Codecs::CodedReference::c_id

static

Code to identify Reference.

Referenced by getPayloadSize().

Collaboration diagram for DUNE::Utils::Codecs::CodedReference: