DUNE: Uniform Navigational Environment
2016.09.0
|
Public Types | |
enum | TypeEnum { FC_REQUEST, FC_REPORT } |
enum | OperationEnum { OP_START, OP_STOP, OP_READY, OP_EXECUTING, OP_FAILURE } |
enum | FormationReferenceFrameEnum { OP_EARTH_FIXED, OP_PATH_FIXED, OP_PATH_CURVED } |
Public Member Functions | |
Formation (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 | |
std::string | formation_name |
uint8_t | type |
uint8_t | op |
std::string | group_name |
std::string | plan_id |
std::string | description |
uint8_t | reference_frame |
MessageList < VehicleFormationParticipant > | participants |
fp32_t | leader_bank_lim |
fp32_t | leader_speed_min |
fp32_t | leader_speed_max |
fp32_t | leader_alt_min |
fp32_t | leader_alt_max |
fp32_t | pos_sim_err_lim |
fp32_t | pos_sim_err_wrn |
uint16_t | pos_sim_err_timeout |
fp32_t | converg_max |
uint16_t | converg_timeout |
uint16_t | comms_timeout |
fp32_t | turb_lim |
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 |
DUNE::IMC::Formation::Formation | ( | void | ) |
References clear(), DUNE::IMC::Message::m_header, DUNE::IMC::Header::mgid, and participants.
Referenced by clone().
|
virtual |
Reset message's fields.
Implements DUNE::IMC::Message.
References comms_timeout, converg_max, converg_timeout, custom, description, formation_name, group_name, leader_alt_max, leader_alt_min, leader_bank_lim, leader_speed_max, leader_speed_min, op, participants, plan_id, pos_sim_err_lim, pos_sim_err_timeout, pos_sim_err_wrn, reference_frame, turb_lim, and type.
Referenced by Formation().
|
inlinevirtual |
Retrieve a copy of the message.
Implements DUNE::IMC::Message.
References Formation().
|
virtual |
Deserialize message fields from a packet.
bfr | stream of bytes (packet) |
len | length of the byte stream. |
Implements DUNE::IMC::Message.
References comms_timeout, converg_max, converg_timeout, custom, description, DUNE::IMC::deserialize(), formation_name, group_name, leader_alt_max, leader_alt_min, leader_bank_lim, leader_speed_max, leader_speed_min, op, participants, plan_id, pos_sim_err_lim, pos_sim_err_timeout, pos_sim_err_wrn, reference_frame, turb_lim, and type.
|
virtual |
Compare fields for equality.
[in] | other | message to compare. |
Reimplemented from DUNE::IMC::Message.
References comms_timeout, converg_max, converg_timeout, custom, description, formation_name, group_name, leader_alt_max, leader_alt_min, leader_bank_lim, leader_speed_max, leader_speed_min, op, participants, plan_id, pos_sim_err_lim, pos_sim_err_timeout, pos_sim_err_wrn, reference_frame, turb_lim, and type.
|
virtual |
Output the message fields (excluding header) in JSON format.
os | output stream. |
indent_level | number of indentation spaces. |
Reimplemented from DUNE::IMC::Message.
References comms_timeout, converg_max, converg_timeout, custom, description, formation_name, group_name, leader_alt_max, leader_alt_min, leader_bank_lim, leader_speed_max, leader_speed_min, op, participants, plan_id, pos_sim_err_lim, pos_sim_err_timeout, pos_sim_err_wrn, reference_frame, DUNE::IMC::toJSON(), turb_lim, and type.
|
inlinevirtual |
Get the fixed amount of bytes required to properly serialize this message (variable length fields are not included).
Reimplemented from DUNE::IMC::Message.
|
inlinevirtual |
Retrieve message's identification number.
Implements DUNE::IMC::Message.
References getIdStatic().
|
inlinestatic |
Referenced by getId().
|
inlinevirtual |
|
inlinevirtual |
Get the variable amount of bytes required to properly serialize this message (only the variable fields are included).
Reimplemented from DUNE::IMC::Message.
References custom, description, formation_name, DUNE::IMC::getSerializationSize(), group_name, participants, and plan_id.
|
virtual |
Deserialize message fields from a packet, swapping the byte order.
bfr | stream of bytes (packet) |
len | length of the byte stream. |
Implements DUNE::IMC::Message.
References comms_timeout, converg_max, converg_timeout, custom, description, DUNE::IMC::deserialize(), formation_name, group_name, leader_alt_max, leader_alt_min, leader_bank_lim, leader_speed_max, leader_speed_min, op, participants, plan_id, pos_sim_err_lim, pos_sim_err_timeout, pos_sim_err_wrn, reference_frame, DUNE::IMC::reverseDeserialize(), turb_lim, and type.
|
virtual |
Implements DUNE::IMC::Message.
References comms_timeout, converg_max, converg_timeout, custom, description, formation_name, group_name, leader_alt_max, leader_alt_min, leader_bank_lim, leader_speed_max, leader_speed_min, op, participants, plan_id, pos_sim_err_lim, pos_sim_err_timeout, pos_sim_err_wrn, reference_frame, DUNE::IMC::serialize(), turb_lim, and type.
|
protectedvirtual |
Set the destination entity of nested messages.
[in] | value | destination entity. |
Reimplemented from DUNE::IMC::Message.
References participants.
|
protectedvirtual |
Set the destination address of nested messages.
[in] | value | destination address. |
Reimplemented from DUNE::IMC::Message.
References participants.
|
protectedvirtual |
Set the source entity of nested messages.
[in] | value | source entity. |
Reimplemented from DUNE::IMC::Message.
References participants.
|
protectedvirtual |
Set the source address of nested messages.
[in] | value | source address. |
Reimplemented from DUNE::IMC::Message.
References participants.
|
protectedvirtual |
Set the timestamp of nested messages.
[in] | value | timestamp. |
Reimplemented from DUNE::IMC::Message.
References participants.
|
virtual |
Validate the message's contents.
Implements DUNE::IMC::Message.
uint16_t DUNE::IMC::Formation::comms_timeout |
Communications time-out.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
fp32_t DUNE::IMC::Formation::converg_max |
Convergence threshold.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
uint16_t DUNE::IMC::Formation::converg_timeout |
Convergence time-out.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
std::string DUNE::IMC::Formation::custom |
Custom settings for maneuver.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), getVariableSerializationSize(), reverseDeserializeFields(), and serializeFields().
std::string DUNE::IMC::Formation::description |
Plan Description.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), getVariableSerializationSize(), reverseDeserializeFields(), and serializeFields().
std::string DUNE::IMC::Formation::formation_name |
Formation Name.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), getVariableSerializationSize(), reverseDeserializeFields(), and serializeFields().
std::string DUNE::IMC::Formation::group_name |
Target Group Name.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), getVariableSerializationSize(), reverseDeserializeFields(), and serializeFields().
fp32_t DUNE::IMC::Formation::leader_alt_max |
Formation Leader Maximum Altitude.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
fp32_t DUNE::IMC::Formation::leader_alt_min |
Formation Leader Minimum Altitude.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
fp32_t DUNE::IMC::Formation::leader_bank_lim |
Formation Leader Bank Limit.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
fp32_t DUNE::IMC::Formation::leader_speed_max |
Formation Leader Maximum Speed.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
fp32_t DUNE::IMC::Formation::leader_speed_min |
Formation Leader Minimum Speed.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
uint8_t DUNE::IMC::Formation::op |
Operation.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
MessageList<VehicleFormationParticipant> DUNE::IMC::Formation::participants |
Formation Participants.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), Formation(), getVariableSerializationSize(), reverseDeserializeFields(), serializeFields(), setDestinationEntityNested(), setDestinationNested(), setSourceEntityNested(), setSourceNested(), and setTimeStampNested().
std::string DUNE::IMC::Formation::plan_id |
fp32_t DUNE::IMC::Formation::pos_sim_err_lim |
Position mismatch limit.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
uint16_t DUNE::IMC::Formation::pos_sim_err_timeout |
Position mismatch time-out.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
fp32_t DUNE::IMC::Formation::pos_sim_err_wrn |
Position mismatch threshold.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
uint8_t DUNE::IMC::Formation::reference_frame |
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
fp32_t DUNE::IMC::Formation::turb_lim |
Turbulence limit.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
uint8_t DUNE::IMC::Formation::type |
Type.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().