DUNE: Uniform Navigational Environment  2019.02.0
DUNE::IMC::FormationParameters Class Reference

Detailed Description

Formation Parameters.

Public Types

enum  FormationReferenceFrameEnum { OP_EARTH_FIXED, OP_PATH_FIXED, OP_PATH_CURVED }
 

Public Member Functions

 FormationParameters (void)
 
FormationParametersclone (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

std::string formation_name
 
uint8_t reference_frame
 
MessageList
< VehicleFormationParticipant
participants
 
std::string custom
 

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

Formation Reference Frame.

Enumerator
OP_EARTH_FIXED 

Earth Fixed.

OP_PATH_FIXED 

Path Fixed.

OP_PATH_CURVED 

Path Curved.

Constructor & Destructor Documentation

DUNE::IMC::FormationParameters::FormationParameters ( void  )

Member Function Documentation

void DUNE::IMC::FormationParameters::clear ( void  )
virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References custom, formation_name, participants, and reference_frame.

Referenced by FormationParameters().

FormationParameters* DUNE::IMC::FormationParameters::clone ( void  ) const
inlinevirtual

Retrieve a copy of the message.

Returns
message copy.

Implements DUNE::IMC::Message.

References FormationParameters().

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

Deserialize message fields from a packet.

Parameters
bfrstream of bytes (packet)
lenlength of the byte stream.
Returns
number of bytes processed.

Implements DUNE::IMC::Message.

References custom, DUNE::IMC::deserialize(), formation_name, participants, and reference_frame.

bool DUNE::IMC::FormationParameters::fieldsEqual ( const Message other) const
virtual

Compare fields for equality.

Parameters
[in]othermessage to compare.
Returns
true if fields are equal, false otherwise.

Reimplemented from DUNE::IMC::Message.

References custom, formation_name, participants, and reference_frame.

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

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

Parameters
osoutput stream.
indent_levelnumber of indentation spaces.

Reimplemented from DUNE::IMC::Message.

References custom, formation_name, participants, reference_frame, and DUNE::IMC::toJSON().

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

Referenced by getId().

const char* DUNE::IMC::FormationParameters::getName ( void  ) const
inlinevirtual

Retrieve message's name.

Returns
message's name.

Implements DUNE::IMC::Message.

unsigned DUNE::IMC::FormationParameters::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 custom, formation_name, DUNE::IMC::getSerializationSize(), and participants.

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

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

Parameters
bfrstream of bytes (packet)
lenlength of the byte stream.
Returns
number of bytes processed.

Implements DUNE::IMC::Message.

References custom, DUNE::IMC::deserialize(), formation_name, participants, reference_frame, and DUNE::IMC::reverseDeserialize().

uint8_t * DUNE::IMC::FormationParameters::serializeFields ( uint8_t *  bfr__) const
virtual
void DUNE::IMC::FormationParameters::setDestinationEntityNested ( uint8_t  value)
protectedvirtual

Set the destination entity of nested messages.

Parameters
[in]valuedestination entity.

Reimplemented from DUNE::IMC::Message.

References participants.

void DUNE::IMC::FormationParameters::setDestinationNested ( uint16_t  value)
protectedvirtual

Set the destination address of nested messages.

Parameters
[in]valuedestination address.

Reimplemented from DUNE::IMC::Message.

References participants.

void DUNE::IMC::FormationParameters::setSourceEntityNested ( uint8_t  value)
protectedvirtual

Set the source entity of nested messages.

Parameters
[in]valuesource entity.

Reimplemented from DUNE::IMC::Message.

References participants.

void DUNE::IMC::FormationParameters::setSourceNested ( uint16_t  value)
protectedvirtual

Set the source address of nested messages.

Parameters
[in]valuesource address.

Reimplemented from DUNE::IMC::Message.

References participants.

void DUNE::IMC::FormationParameters::setTimeStampNested ( double  value)
protectedvirtual

Set the timestamp of nested messages.

Parameters
[in]valuetimestamp.

Reimplemented from DUNE::IMC::Message.

References participants.

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

std::string DUNE::IMC::FormationParameters::custom
std::string DUNE::IMC::FormationParameters::formation_name
uint8_t DUNE::IMC::FormationParameters::reference_frame
Collaboration diagram for DUNE::IMC::FormationParameters:
Collaboration graph