Detailed Description

Reference To Follow.

Public Types
enum	FlagsBits { FLAG_LOCATION, FLAG_SPEED, FLAG_Z, FLAG_RADIUS, FLAG_START_POINT, FLAG_DIRECT, FLAG_MANDONE }

Public Member Functions
	Reference (void)

Reference *	clone (void) const

void	clear (void)

bool	fieldsEqual (const Message &msg__) const

int	validate (void) const

uint8_t *	serializeFields (uint8_t *bfr__) const

uint16_t	deserializeFields (const uint8_t *bfr__, uint16_t size__)

uint16_t	reverseDeserializeFields (const uint8_t *bfr__, uint16_t size__)

uint16_t	getId (void) const

const char *	getName (void) const

unsigned	getFixedSerializationSize (void) const

unsigned	getVariableSerializationSize (void) const

void	fieldsToJSON (std::ostream &os__, unsigned nindent__) const

Public Member Functions inherited from DUNE::IMC::Message
	Message (void)

virtual	~Message (void)

double	setTimeStamp (double ts)

double	setTimeStamp (void)

double	getTimeStamp (void) const

uint16_t	getSource (void) const

void	setSource (uint16_t src)

uint8_t	getSourceEntity (void) const

void	setSourceEntity (uint8_t src_ent)

uint16_t	getDestination (void) const

void	setDestination (uint16_t dst)

uint8_t	getDestinationEntity (void) const

void	setDestinationEntity (uint8_t dst_ent)

virtual uint16_t	getSubId (void) const

virtual void	setSubId (uint16_t subid)

virtual fp64_t	getValueFP (void) const

virtual void	setValueFP (fp64_t val)

unsigned	getSerializationSize (void) const

unsigned	getPayloadSerializationSize (void) const

void	toJSON (std::ostream &os) const

void	toText (std::ostream &os) const

bool	operator== (const Message &other) const

bool	operator!= (const Message &other) const

Static Public Member Functions
static uint16_t	getIdStatic (void)

Public Attributes
uint8_t	flags

InlineMessage< DesiredSpeed >	speed

InlineMessage< DesiredZ >	z

fp64_t	lat

fp64_t	lon

fp32_t	radius

Protected Member Functions
void	setTimeStampNested (double value__)

void	setSourceNested (uint16_t value__)

void	setSourceEntityNested (uint8_t value__)

void	setDestinationNested (uint16_t value__)

void	setDestinationEntityNested (uint8_t value__)

Additional Inherited Members
Protected Attributes inherited from DUNE::IMC::Message
Header	m_header

Member Enumeration Documentation

◆ FlagsBits

enum DUNE::IMC::Reference::FlagsBits

Flags.

Enumerator
FLAG_LOCATION	Use Location Reference.
FLAG_SPEED	Use Speed Reference.
FLAG_Z	Use Z Reference.
FLAG_RADIUS	Use Radius Reference.
FLAG_START_POINT	Use this Reference as Start Position for PathControler.
FLAG_DIRECT	Use Current Position as Start Position for PathControler.
FLAG_MANDONE	Flag Maneuver Completion.

Constructor & Destructor Documentation

◆ Reference()

DUNE::IMC::Reference::Reference ( void )

References DUNE::IMC::EntityState::clear(), DUNE::IMC::Message::m_header, and DUNE::IMC::Header::mgid.

Member Function Documentation

◆ clear()

void DUNE::IMC::Reference::clear ( void )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References DUNE::IMC::EntityState::flags.

◆ clone()

Reference* DUNE::IMC::Reference::clone ( void ) const

inlinevirtual

Retrieve a copy of the message.

Returns: message copy.

Implements DUNE::IMC::Message.

References DUNE::IMC::EntityState::clear(), DUNE::IMC::EntityState::deserializeFields(), DUNE::IMC::EntityState::fieldsEqual(), DUNE::IMC::EntityState::reverseDeserializeFields(), DUNE::IMC::EntityState::serializeFields(), and DUNE::IMC::EntityState::validate().

◆ deserializeFields()

uint16_t DUNE::IMC::Reference::deserializeFields	(	const uint8_t *	bfr,
		uint16_t	len
	)

virtual

Deserialize message fields from a packet.

Parameters

bfr	stream of bytes (packet)
len	length of the byte stream.

Returns: number of bytes processed.

Implements DUNE::IMC::Message.

References DUNE::IMC::deserialize(), and DUNE::IMC::EntityState::flags.

◆ fieldsEqual()

bool DUNE::IMC::Reference::fieldsEqual ( const Message & other ) const

virtual

Compare fields for equality.

Parameters

[in] other message to compare.

Returns: true if fields are equal, false otherwise.

Reimplemented from DUNE::IMC::Message.

References DUNE::IMC::EntityState::flags, flags, lat, lon, radius, speed, and z.

◆ fieldsToJSON()

void DUNE::IMC::Reference::fieldsToJSON	(	std::ostream &	os,
		unsigned	indent_level
	)		const

virtual

Output the message fields (excluding header) in JSON format.

Parameters

os	output stream.
indent_level	number of indentation spaces.

Reimplemented from DUNE::IMC::Message.

References DUNE::IMC::EntityState::flags, and DUNE::IMC::toJSON().

◆ getFixedSerializationSize()

unsigned DUNE::IMC::Reference::getFixedSerializationSize ( void ) const

inlinevirtual

Get the fixed amount of bytes required to properly serialize this message (variable length fields are not included).

Returns: amount of variable bytes required to serialize the message.

Reimplemented from DUNE::IMC::Message.

◆ getId()

uint16_t DUNE::IMC::Reference::getId ( void ) const

inlinevirtual

Retrieve message's identification number.

Returns: message's identification number.

Implements DUNE::IMC::Message.

References getIdStatic().

◆ getIdStatic()

static uint16_t DUNE::IMC::Reference::getIdStatic ( void )

inlinestatic

Referenced by getId().

◆ getName()

const char* DUNE::IMC::Reference::getName ( void ) const

inlinevirtual

Retrieve message's name.

Returns: message's name.

Implements DUNE::IMC::Message.

◆ getVariableSerializationSize()

unsigned DUNE::IMC::Reference::getVariableSerializationSize ( void ) const

inlinevirtual

Get the variable amount of bytes required to properly serialize this message (only the variable fields are included).

Returns: amount of variable bytes required to serialize the message.

Reimplemented from DUNE::IMC::Message.

References DUNE::IMC::EntityState::fieldsToJSON(), DUNE::IMC::InlineMessage< Type >::getSerializationSize(), DUNE::IMC::Message::setDestinationEntityNested(), DUNE::IMC::Message::setDestinationNested(), DUNE::IMC::Message::setSourceEntityNested(), DUNE::IMC::Message::setSourceNested(), and DUNE::IMC::Message::setTimeStampNested().

◆ reverseDeserializeFields()

uint16_t DUNE::IMC::Reference::reverseDeserializeFields	(	const uint8_t *	bfr,
		uint16_t	len
	)

virtual

Deserialize message fields from a packet, swapping the byte order.

Parameters

bfr	stream of bytes (packet)
len	length of the byte stream.

Returns: number of bytes processed.

Implements DUNE::IMC::Message.

References DUNE::IMC::deserialize(), DUNE::IMC::EntityState::flags, and DUNE::IMC::reverseDeserialize().

◆ serializeFields()

uint8_t * DUNE::IMC::Reference::serializeFields ( uint8_t * bfr__ ) const

virtual

Implements DUNE::IMC::Message.

References DUNE::IMC::EntityState::flags, and DUNE::IMC::serialize().

◆ setDestinationEntityNested()

void DUNE::IMC::Reference::setDestinationEntityNested ( uint8_t value )

protectedvirtual

Set the destination entity of nested messages.

Parameters

[in] value destination entity.

Reimplemented from DUNE::IMC::Message.

◆ setDestinationNested()

void DUNE::IMC::Reference::setDestinationNested ( uint16_t value )

protectedvirtual

Set the destination address of nested messages.

Parameters

[in] value destination address.

Reimplemented from DUNE::IMC::Message.

◆ setSourceEntityNested()

void DUNE::IMC::Reference::setSourceEntityNested ( uint8_t value )

protectedvirtual

Set the source entity of nested messages.

Parameters

[in] value source entity.

Reimplemented from DUNE::IMC::Message.

◆ setSourceNested()

void DUNE::IMC::Reference::setSourceNested ( uint16_t value )

protectedvirtual

Set the source address of nested messages.

Parameters

[in] value source address.

Reimplemented from DUNE::IMC::Message.

◆ setTimeStampNested()

void DUNE::IMC::Reference::setTimeStampNested ( double value )

protectedvirtual

Set the timestamp of nested messages.

Parameters

[in] value timestamp.

Reimplemented from DUNE::IMC::Message.

◆ validate()

int DUNE::IMC::Reference::validate ( void ) const

virtual

Validate the message's contents.

Returns: negative value in case of a valid message or a positive value indicating the position of the invalid message field.

Implements DUNE::IMC::Message.

Member Data Documentation

◆ flags

uint8_t DUNE::IMC::Reference::flags

Flags.

Referenced by fieldsEqual(), and DUNE::Utils::Codecs::CodedReference::getPayloadSize().

◆ lat

fp64_t DUNE::IMC::Reference::lat

Latitude Reference.

Referenced by fieldsEqual(), and DUNE::Utils::Codecs::CodedReference::getPayloadSize().

◆ lon

fp64_t DUNE::IMC::Reference::lon

Longitude Reference.

Referenced by fieldsEqual(), and DUNE::Utils::Codecs::CodedReference::getPayloadSize().

◆ radius

fp32_t DUNE::IMC::Reference::radius

Radius.

Referenced by fieldsEqual(), and DUNE::Utils::Codecs::CodedReference::getPayloadSize().

◆ speed

InlineMessage<DesiredSpeed> DUNE::IMC::Reference::speed

Speed Reference.

Referenced by fieldsEqual().

◆ z

InlineMessage<DesiredZ> DUNE::IMC::Reference::z

Z Reference.

Referenced by fieldsEqual(), and DUNE::Utils::Codecs::CodedReference::getPayloadSize().

Collaboration diagram for DUNE::IMC::Reference:

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ FlagsBits

Constructor & Destructor Documentation

◆ Reference()

Member Function Documentation

◆ clear()

◆ clone()

◆ deserializeFields()

◆ fieldsEqual()

◆ fieldsToJSON()

◆ getFixedSerializationSize()

◆ getId()

◆ getIdStatic()

◆ getName()

◆ getVariableSerializationSize()

◆ reverseDeserializeFields()

◆ serializeFields()

◆ setDestinationEntityNested()

◆ setDestinationNested()

◆ setSourceEntityNested()

◆ setSourceNested()

◆ setTimeStampNested()

◆ validate()

Member Data Documentation

◆ flags

◆ lat

◆ lon

◆ radius

◆ speed

◆ z