DUNE: Uniform Navigational Environment
2016.09.0
|
Public Types | |
enum | LoiterTypeEnum { LT_DEFAULT, LT_CIRCULAR, LT_RACETRACK, LT_EIGHT, LT_HOVER } |
enum | DirectionEnum { LD_VDEP, LD_CLOCKW, LD_CCLOCKW, LD_IWINDCURR } |
Public Member Functions | |
Loiter (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 | |
uint16_t | timeout |
fp64_t | lat |
fp64_t | lon |
fp32_t | z |
uint8_t | z_units |
uint16_t | duration |
fp32_t | speed |
uint8_t | speed_units |
uint8_t | type |
fp32_t | radius |
fp32_t | length |
fp64_t | bearing |
uint8_t | direction |
std::string | custom |
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 |
Loiter Type.
Enumerator | |
---|---|
LT_DEFAULT |
Default. |
LT_CIRCULAR |
Circular. |
LT_RACETRACK |
Race track. |
LT_EIGHT |
Figure 8. |
LT_HOVER |
Hover. |
DUNE::IMC::Loiter::Loiter | ( | void | ) |
References clear(), DUNE::IMC::Message::m_header, and DUNE::IMC::Header::mgid.
Referenced by clone().
|
virtual |
|
inlinevirtual |
Retrieve a copy of the message.
Implements DUNE::IMC::Message.
References Loiter().
|
virtual |
Deserialize message fields from a packet.
bfr | stream of bytes (packet) |
len | length of the byte stream. |
Implements DUNE::IMC::Message.
References bearing, custom, DUNE::IMC::deserialize(), direction, duration, lat, length, lon, radius, speed, speed_units, timeout, type, z, and z_units.
|
virtual |
|
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 bearing, custom, direction, duration, lat, length, lon, radius, speed, speed_units, timeout, DUNE::IMC::toJSON(), type, z, and z_units.
|
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, and DUNE::IMC::getSerializationSize().
|
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 bearing, custom, DUNE::IMC::deserialize(), direction, duration, lat, length, lon, radius, DUNE::IMC::reverseDeserialize(), speed, speed_units, timeout, type, z, and z_units.
|
virtual |
|
virtual |
Validate the message's contents.
Implements DUNE::IMC::Message.
fp64_t DUNE::IMC::Loiter::bearing |
std::string DUNE::IMC::Loiter::custom |
Custom settings for maneuver.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), getVariableSerializationSize(), reverseDeserializeFields(), and serializeFields().
uint8_t DUNE::IMC::Loiter::direction |
Direction.
Referenced by DUNE::Maneuvers::Circular::Circular(), clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), DUNE::Parsers::PlanConfigParser::parse(), reverseDeserializeFields(), serializeFields(), and validate().
uint16_t DUNE::IMC::Loiter::duration |
Duration.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
fp64_t DUNE::IMC::Loiter::lat |
Latitude WGS-84.
Referenced by DUNE::Maneuvers::Circular::Circular(), clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), DUNE::Maneuvers::FigureEight::FigureEight(), reverseDeserializeFields(), and serializeFields().
fp32_t DUNE::IMC::Loiter::length |
fp64_t DUNE::IMC::Loiter::lon |
Longitude WGS-84.
Referenced by DUNE::Maneuvers::Circular::Circular(), clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), DUNE::Maneuvers::FigureEight::FigureEight(), reverseDeserializeFields(), and serializeFields().
fp32_t DUNE::IMC::Loiter::radius |
fp32_t DUNE::IMC::Loiter::speed |
uint8_t DUNE::IMC::Loiter::speed_units |
uint16_t DUNE::IMC::Loiter::timeout |
Timeout.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().
uint8_t DUNE::IMC::Loiter::type |
Loiter Type.
Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), DUNE::Parsers::PlanConfigParser::parse(), reverseDeserializeFields(), serializeFields(), and validate().
fp32_t DUNE::IMC::Loiter::z |
uint8_t DUNE::IMC::Loiter::z_units |