DUNE::IMC::FormationState Class Reference

Detailed Description

Formation Tracking State.

Public Types
enum	TypeEnum { FC_REQUEST, FC_REPORT }
enum	OperationEnum { OP_START, OP_STOP }
enum	PositionMismatchMonitorEnum { POS_OK, POS_WRN, POS_LIM }
enum	CommunicationsMonitorEnum { COMMS_OK, COMMS_TIMEOUT }
enum	ConvergenceEnum { CONV_OK, CONV_TIMEOUT }

Public Member Functions
	FormationState (void)
FormationState *	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
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
virtual unsigned	getVariableSerializationSize (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	possimerr
fp32_t	converg
fp32_t	turbulence
uint8_t	possimmon
uint8_t	commmon
uint8_t	convergmon

Additional Inherited Members
Protected Member Functions inherited from DUNE::IMC::Message
virtual void	setTimeStampNested (double value)
virtual void	setSourceNested (uint16_t value)
virtual void	setSourceEntityNested (uint8_t value)
virtual void	setDestinationNested (uint16_t value)
virtual void	setDestinationEntityNested (uint8_t value)
Protected Attributes inherited from DUNE::IMC::Message
Header	m_header

Member Enumeration Documentation

enum DUNE::IMC::FormationState::CommunicationsMonitorEnum

Communications Monitor.

Enumerator
COMMS_OK	Ok.
COMMS_TIMEOUT	Timeout.

enum DUNE::IMC::FormationState::ConvergenceEnum

Convergence.

Enumerator
CONV_OK	Ok.
CONV_TIMEOUT	Timeout.

enum DUNE::IMC::FormationState::OperationEnum

Operation.

Enumerator
OP_START	Start.
OP_STOP	Stop.

enum DUNE::IMC::FormationState::PositionMismatchMonitorEnum

Position Mismatch Monitor.

Enumerator
POS_OK	Ok.
POS_WRN	Warning threshold.
POS_LIM	Limit threshold.

enum DUNE::IMC::FormationState::TypeEnum

Type.

Enumerator
FC_REQUEST	Request.
FC_REPORT	Report.

Constructor & Destructor Documentation

DUNE::IMC::FormationState::FormationState

(

void

)

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

Referenced by clone().

Member Function Documentation

void DUNE::IMC::FormationState::clear ( void  )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References commmon, converg, convergmon, op, possimerr, possimmon, turbulence, and type.

Referenced by FormationState().

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

inlinevirtual

Retrieve a copy of the message.

Returns

message copy.

Implements DUNE::IMC::Message.

References FormationState().

uint16_t DUNE::IMC::FormationState::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 commmon, converg, convergmon, DUNE::IMC::deserialize(), op, possimerr, possimmon, turbulence, and type.

bool DUNE::IMC::FormationState::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 commmon, converg, convergmon, op, possimerr, possimmon, turbulence, and type.

void DUNE::IMC::FormationState::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 commmon, converg, convergmon, op, possimerr, possimmon, DUNE::IMC::toJSON(), turbulence, and type.

unsigned DUNE::IMC::FormationState::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.

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

inlinevirtual

Retrieve message's identification number.

Returns

message's identification number.

Implements DUNE::IMC::Message.

References getIdStatic().

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

inlinestatic

Referenced by getId().

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

inlinevirtual

Retrieve message's name.

Returns

message's name.

Implements DUNE::IMC::Message.

uint16_t DUNE::IMC::FormationState::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 commmon, converg, convergmon, DUNE::IMC::deserialize(), op, possimerr, possimmon, DUNE::IMC::reverseDeserialize(), turbulence, and type.

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

virtual

Implements DUNE::IMC::Message.

References commmon, converg, convergmon, op, possimerr, possimmon, DUNE::IMC::serialize(), turbulence, and type.

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

uint8_t DUNE::IMC::FormationState::commmon

Communications Monitor.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

fp32_t DUNE::IMC::FormationState::converg

Convergence.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

uint8_t DUNE::IMC::FormationState::convergmon

Convergence.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

uint8_t DUNE::IMC::FormationState::op

Operation.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

fp32_t DUNE::IMC::FormationState::possimerr

Position Mismatch.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

uint8_t DUNE::IMC::FormationState::possimmon

Position Mismatch Monitor.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

fp32_t DUNE::IMC::FormationState::turbulence

Stream Turbulence.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

uint8_t DUNE::IMC::FormationState::type

Type.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

Collaboration diagram for DUNE::IMC::FormationState: