Detailed Description

Formation Evaluation Data.

Public Types
enum	TypeEnum { FC_REQUEST, FC_REPORT }

enum	OperationEnum { OP_START, OP_STOP, OP_READY, OP_EXECUTING, OP_FAILURE }

Public Member Functions
	FormationEvaluation (void)

FormationEvaluation *	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	type

uint8_t	op

fp32_t	err_mean

fp32_t	dist_min_abs

fp32_t	dist_min_mean

fp32_t	roll_rate_mean

fp32_t	time

InlineMessage< FormationControlParams >	controlparams

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

◆ OperationEnum

enum DUNE::IMC::FormationEvaluation::OperationEnum

Operation.

Enumerator
OP_START	Start.
OP_STOP	Stop.
OP_READY	Ready.
OP_EXECUTING	Executing.
OP_FAILURE	Failure.

◆ TypeEnum

enum DUNE::IMC::FormationEvaluation::TypeEnum

Type.

Enumerator
FC_REQUEST	Request.
FC_REPORT	Report.

Constructor & Destructor Documentation

◆ FormationEvaluation()

DUNE::IMC::FormationEvaluation::FormationEvaluation ( void )

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

Member Function Documentation

◆ clear()

void DUNE::IMC::FormationEvaluation::clear ( void )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

◆ clone()

FormationEvaluation* DUNE::IMC::FormationEvaluation::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::FormationEvaluation::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().

◆ fieldsEqual()

bool DUNE::IMC::FormationEvaluation::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 controlparams, dist_min_abs, dist_min_mean, err_mean, op, roll_rate_mean, time, and type.

◆ fieldsToJSON()

void DUNE::IMC::FormationEvaluation::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::toJSON().

◆ getFixedSerializationSize()

unsigned DUNE::IMC::FormationEvaluation::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::FormationEvaluation::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::FormationEvaluation::getIdStatic ( void )

inlinestatic

Referenced by getId().

◆ getName()

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

inlinevirtual

Retrieve message's name.

Returns: message's name.

Implements DUNE::IMC::Message.

◆ getVariableSerializationSize()

unsigned DUNE::IMC::FormationEvaluation::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::FormationEvaluation::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(), and DUNE::IMC::reverseDeserialize().

◆ serializeFields()

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

virtual

Implements DUNE::IMC::Message.

References DUNE::IMC::serialize().

◆ setDestinationEntityNested()

void DUNE::IMC::FormationEvaluation::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::FormationEvaluation::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::FormationEvaluation::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::FormationEvaluation::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::FormationEvaluation::setTimeStampNested ( double value )

protectedvirtual

Set the timestamp of nested messages.

Parameters

[in] value timestamp.

Reimplemented from DUNE::IMC::Message.

◆ validate()

int DUNE::IMC::FormationEvaluation::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

◆ controlparams

InlineMessage<FormationControlParams> DUNE::IMC::FormationEvaluation::controlparams

Formation Control Parameters.

Referenced by fieldsEqual().

◆ dist_min_abs

fp32_t DUNE::IMC::FormationEvaluation::dist_min_abs

Absolute Minimum Distance.

Referenced by fieldsEqual().

◆ dist_min_mean

fp32_t DUNE::IMC::FormationEvaluation::dist_min_mean

Mean Minimum Distance.

Referenced by fieldsEqual().

◆ err_mean

fp32_t DUNE::IMC::FormationEvaluation::err_mean

Mean Position Error.

Referenced by fieldsEqual().

◆ op

uint8_t DUNE::IMC::FormationEvaluation::op

Operation.

Referenced by fieldsEqual().

◆ roll_rate_mean

fp32_t DUNE::IMC::FormationEvaluation::roll_rate_mean

Mean Roll Rate.

Referenced by fieldsEqual().

◆ time

fp32_t DUNE::IMC::FormationEvaluation::time

Evaluation Time.

Referenced by fieldsEqual().

◆ type

uint8_t DUNE::IMC::FormationEvaluation::type

Type.

Referenced by fieldsEqual().

Collaboration diagram for DUNE::IMC::FormationEvaluation:

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ OperationEnum

◆ TypeEnum

Constructor & Destructor Documentation

◆ FormationEvaluation()

Member Function Documentation

◆ clear()

◆ clone()

◆ deserializeFields()

◆ fieldsEqual()

◆ fieldsToJSON()

◆ getFixedSerializationSize()

◆ getId()

◆ getIdStatic()

◆ getName()

◆ getVariableSerializationSize()

◆ reverseDeserializeFields()

◆ serializeFields()

◆ setDestinationEntityNested()

◆ setDestinationNested()

◆ setSourceEntityNested()

◆ setSourceNested()

◆ setTimeStampNested()

◆ validate()

Member Data Documentation

◆ controlparams

◆ dist_min_abs

◆ dist_min_mean

◆ err_mean

◆ op

◆ roll_rate_mean

◆ time

◆ type