DUNE::IMC::DesiredControl Class Reference

Detailed Description

Desired Control.

Public Types
enum	FlagsBits {   FL_X, FL_Y, FL_Z, FL_K,   FL_M, FL_N }

Public Member Functions
	DesiredControl (void)
DesiredControl *	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
fp64_t	x
fp64_t	y
fp64_t	z
fp64_t	k
fp64_t	m
fp64_t	n
uint8_t	flags

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

FlagsBits

enum DUNE::IMC::DesiredControl::FlagsBits

Flags.

Enumerator
FL_X	Value of X is meaningful.
FL_Y	Value of Y is meaningful.
FL_Z	Value of Z is meaningful.
FL_K	Value of K is meaningful.
FL_M	Value of M is meaningful.
FL_N	Value of N is meaningful.

Constructor & Destructor Documentation

DesiredControl()

DUNE::IMC::DesiredControl::DesiredControl

(

void

)

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

Member Function Documentation

clear()

void DUNE::IMC::DesiredControl::clear ( void  )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

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

clone()

DesiredControl* DUNE::IMC::DesiredControl::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::DesiredControl::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::DesiredControl::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, k, m, n, x, y, and z.

fieldsToJSON()

void DUNE::IMC::DesiredControl::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::DesiredControl::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.

References DUNE::IMC::EntityState::fieldsToJSON().

getId()

uint16_t DUNE::IMC::DesiredControl::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::DesiredControl::getIdStatic ( void  )

inlinestatic

Referenced by getId().

getName()

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

inlinevirtual

Retrieve message's name.

Returns

message's name.

Implements DUNE::IMC::Message.

reverseDeserializeFields()

uint16_t DUNE::IMC::DesiredControl::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::DesiredControl::serializeFields ( uint8_t *  bfr__ ) const

virtual

Implements DUNE::IMC::Message.

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

validate()

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

Flags.

Referenced by fieldsEqual().

k

fp64_t DUNE::IMC::DesiredControl::k

Torque about the x axis.

Referenced by fieldsEqual().

m

fp64_t DUNE::IMC::DesiredControl::m

Torque about the y axis.

Referenced by fieldsEqual().

n

fp64_t DUNE::IMC::DesiredControl::n

Torque about the z axis.

Referenced by fieldsEqual().

x

fp64_t DUNE::IMC::DesiredControl::x

Force along the x axis.

Referenced by fieldsEqual().

y

fp64_t DUNE::IMC::DesiredControl::y

Force along the y axis.

Referenced by fieldsEqual().

z

fp64_t DUNE::IMC::DesiredControl::z

Force along the z axis.

Referenced by fieldsEqual().

Collaboration diagram for DUNE::IMC::DesiredControl: