DUNE::IMC::FormationMonitor Class Reference

Detailed Description

Formation Monitoring Data.

Public Member Functions
	FormationMonitor (void)
Message *	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
fp32_t	ax_cmd
fp32_t	ay_cmd
fp32_t	az_cmd
fp32_t	ax_des
fp32_t	ay_des
fp32_t	az_des
fp32_t	virt_err_x
fp32_t	virt_err_y
fp32_t	virt_err_z
fp32_t	surf_fdbk_x
fp32_t	surf_fdbk_y
fp32_t	surf_fdbk_z
fp32_t	surf_unkn_x
fp32_t	surf_unkn_y
fp32_t	surf_unkn_z
fp32_t	ss_x
fp32_t	ss_y
fp32_t	ss_z
MessageList< RelativeState >	rel_state

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

Constructor & Destructor Documentation

DUNE::IMC::FormationMonitor::FormationMonitor

(

void

)

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

Referenced by clone().

Member Function Documentation

void DUNE::IMC::FormationMonitor::clear ( void  )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References ax_cmd, ax_des, ay_cmd, ay_des, az_cmd, az_des, rel_state, ss_x, ss_y, ss_z, surf_fdbk_x, surf_fdbk_y, surf_fdbk_z, surf_unkn_x, surf_unkn_y, surf_unkn_z, virt_err_x, virt_err_y, and virt_err_z.

Referenced by FormationMonitor().

Message* DUNE::IMC::FormationMonitor::clone ( void  ) const

inlinevirtual

Retrieve a copy of the message.

Returns

message copy.

Implements DUNE::IMC::Message.

References FormationMonitor().

uint16_t DUNE::IMC::FormationMonitor::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 ax_cmd, ax_des, ay_cmd, ay_des, az_cmd, az_des, DUNE::IMC::deserialize(), rel_state, ss_x, ss_y, ss_z, surf_fdbk_x, surf_fdbk_y, surf_fdbk_z, surf_unkn_x, surf_unkn_y, surf_unkn_z, virt_err_x, virt_err_y, and virt_err_z.

bool DUNE::IMC::FormationMonitor::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 ax_cmd, ax_des, ay_cmd, ay_des, az_cmd, az_des, rel_state, ss_x, ss_y, ss_z, surf_fdbk_x, surf_fdbk_y, surf_fdbk_z, surf_unkn_x, surf_unkn_y, surf_unkn_z, virt_err_x, virt_err_y, and virt_err_z.

void DUNE::IMC::FormationMonitor::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 ax_cmd, ax_des, ay_cmd, ay_des, az_cmd, az_des, rel_state, ss_x, ss_y, ss_z, surf_fdbk_x, surf_fdbk_y, surf_fdbk_z, surf_unkn_x, surf_unkn_y, surf_unkn_z, DUNE::IMC::toJSON(), virt_err_x, virt_err_y, and virt_err_z.

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

inlinestatic

Referenced by getId().

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

inlinevirtual

Retrieve message's name.

Returns

message's name.

Implements DUNE::IMC::Message.

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

uint16_t DUNE::IMC::FormationMonitor::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 ax_cmd, ax_des, ay_cmd, ay_des, az_cmd, az_des, rel_state, DUNE::IMC::reverseDeserialize(), ss_x, ss_y, ss_z, surf_fdbk_x, surf_fdbk_y, surf_fdbk_z, surf_unkn_x, surf_unkn_y, surf_unkn_z, virt_err_x, virt_err_y, and virt_err_z.

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

virtual

Implements DUNE::IMC::Message.

References ax_cmd, ax_des, ay_cmd, ay_des, az_cmd, az_des, rel_state, DUNE::IMC::serialize(), ss_x, ss_y, ss_z, surf_fdbk_x, surf_fdbk_y, surf_fdbk_z, surf_unkn_x, surf_unkn_y, surf_unkn_z, virt_err_x, virt_err_y, and virt_err_z.

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

protectedvirtual

Set the destination entity of nested messages.

Parameters

[in]

value

destination entity.

Reimplemented from DUNE::IMC::Message.

References rel_state.

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

protectedvirtual

Set the destination address of nested messages.

Parameters

[in]

value

destination address.

Reimplemented from DUNE::IMC::Message.

References rel_state.

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

protectedvirtual

Set the source entity of nested messages.

Parameters

[in]

value

source entity.

Reimplemented from DUNE::IMC::Message.

References rel_state.

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

protectedvirtual

Set the source address of nested messages.

Parameters

[in]

value

source address.

Reimplemented from DUNE::IMC::Message.

References rel_state.

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

protectedvirtual

Set the timestamp of nested messages.

Parameters

[in]

value

timestamp.

Reimplemented from DUNE::IMC::Message.

References rel_state.

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

fp32_t DUNE::IMC::FormationMonitor::ax_cmd

Commanded X Acceleration (North).

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

fp32_t DUNE::IMC::FormationMonitor::ax_des

Desired X Acceleration (North).

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

fp32_t DUNE::IMC::FormationMonitor::ay_cmd

Commanded Y Acceleration (East).

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

fp32_t DUNE::IMC::FormationMonitor::ay_des

Desired Y Acceleration (East).

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

fp32_t DUNE::IMC::FormationMonitor::az_cmd

Commanded Z Acceleration (Down).

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

fp32_t DUNE::IMC::FormationMonitor::az_des

Desired Z Acceleration (Down).

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

MessageList<RelativeState> DUNE::IMC::FormationMonitor::rel_state

Relative State.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), FormationMonitor(), getVariableSerializationSize(), reverseDeserializeFields(), serializeFields(), setDestinationEntityNested(), setDestinationNested(), setSourceEntityNested(), setSourceNested(), and setTimeStampNested().

fp32_t DUNE::IMC::FormationMonitor::ss_x

X Convergence Deviation (North).

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

fp32_t DUNE::IMC::FormationMonitor::ss_y

Y Convergence Deviation (East).

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

fp32_t DUNE::IMC::FormationMonitor::ss_z

Z Convergence Deviation (Down).

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

fp32_t DUNE::IMC::FormationMonitor::surf_fdbk_x

X Sliding Surface Feedback (North).

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

fp32_t DUNE::IMC::FormationMonitor::surf_fdbk_y

Y Sliding Surface Feedback (East).

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

fp32_t DUNE::IMC::FormationMonitor::surf_fdbk_z

Z Sliding Surface Feedback (Down).

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

fp32_t DUNE::IMC::FormationMonitor::surf_unkn_x

X Uncertainty Compensation (North).

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

fp32_t DUNE::IMC::FormationMonitor::surf_unkn_y

Y Uncertainty Compensation (East).

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

fp32_t DUNE::IMC::FormationMonitor::surf_unkn_z

Z Uncertainty Compensation (Down).

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

fp32_t DUNE::IMC::FormationMonitor::virt_err_x

X Virtual Error (North).

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

fp32_t DUNE::IMC::FormationMonitor::virt_err_y

Y Virtual Error (East).

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

fp32_t DUNE::IMC::FormationMonitor::virt_err_z

Z Virtual Error (Down).

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

Collaboration diagram for DUNE::IMC::FormationMonitor: