DUNE::IMC::DesiredPath Class Reference

Detailed Description

Desired Path.

Public Types
enum	FlagsBits {   FL_START, FL_DIRECT, FL_NO_Z, FL_3DTRACK,   FL_CCLOCKW, FL_LOITER_CURR, FL_TAKEOFF, FL_LAND }

Public Member Functions
	DesiredPath (void)
DesiredPath *	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
uint32_t	path_ref
fp64_t	start_lat
fp64_t	start_lon
fp32_t	start_z
uint8_t	start_z_units
fp64_t	end_lat
fp64_t	end_lon
fp32_t	end_z
uint8_t	end_z_units
fp32_t	speed
uint8_t	speed_units
fp32_t	lradius
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

enum DUNE::IMC::DesiredPath::FlagsBits

Flags.

Enumerator
FL_START	Start Point.
FL_DIRECT	Direct.
FL_NO_Z	No Altitude/Depth control.
FL_3DTRACK	3D Tracking.
FL_CCLOCKW	Counter-Clockwise loiter.
FL_LOITER_CURR	Loiter from current position.
FL_TAKEOFF	Takeoff.
FL_LAND	Land.

Constructor & Destructor Documentation

DUNE::IMC::DesiredPath::DesiredPath

(

void

)

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

Referenced by clone().

Member Function Documentation

void DUNE::IMC::DesiredPath::clear ( void  )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References end_lat, end_lon, end_z, end_z_units, flags, lradius, path_ref, speed, speed_units, start_lat, start_lon, start_z, and start_z_units.

Referenced by DesiredPath(), and DUNE::Maneuvers::Elevate::Elevate().

DesiredPath* DUNE::IMC::DesiredPath::clone ( void  ) const

inlinevirtual

Retrieve a copy of the message.

Returns

message copy.

Implements DUNE::IMC::Message.

References DesiredPath().

uint16_t DUNE::IMC::DesiredPath::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(), end_lat, end_lon, end_z, end_z_units, flags, lradius, path_ref, speed, speed_units, start_lat, start_lon, start_z, and start_z_units.

bool DUNE::IMC::DesiredPath::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 end_lat, end_lon, end_z, end_z_units, flags, lradius, path_ref, speed, speed_units, start_lat, start_lon, start_z, and start_z_units.

void DUNE::IMC::DesiredPath::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 end_lat, end_lon, end_z, end_z_units, flags, lradius, path_ref, speed, speed_units, start_lat, start_lon, start_z, start_z_units, and DUNE::IMC::toJSON().

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

inlinestatic

Referenced by getId().

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

inlinevirtual

Retrieve message's name.

Returns

message's name.

Implements DUNE::IMC::Message.

uint16_t DUNE::IMC::DesiredPath::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(), end_lat, end_lon, end_z, end_z_units, flags, lradius, path_ref, DUNE::IMC::reverseDeserialize(), speed, speed_units, start_lat, start_lon, start_z, and start_z_units.

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

virtual

Implements DUNE::IMC::Message.

References end_lat, end_lon, end_z, end_z_units, flags, lradius, path_ref, DUNE::IMC::serialize(), speed, speed_units, start_lat, start_lon, start_z, and start_z_units.

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

fp64_t DUNE::IMC::DesiredPath::end_lat

End Point – WGS84 Latitude.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), DUNE::Maneuvers::Elevate::Elevate(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), serializeFields(), and DUNE::Maneuvers::StationKeep::StationKeep().

fp64_t DUNE::IMC::DesiredPath::end_lon

End Point – WGS-84 Longitude.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), DUNE::Maneuvers::Elevate::Elevate(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), serializeFields(), and DUNE::Maneuvers::StationKeep::StationKeep().

fp32_t DUNE::IMC::DesiredPath::end_z

End Point – Z Reference.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), serializeFields(), DUNE::Maneuvers::StationKeep::StationKeep(), and DUNE::Maneuvers::Elevate::update().

uint8_t DUNE::IMC::DesiredPath::end_z_units

End Point – Z Units.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), serializeFields(), DUNE::Maneuvers::StationKeep::StationKeep(), and DUNE::Maneuvers::Elevate::update().

uint8_t DUNE::IMC::DesiredPath::flags

Flags.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), serializeFields(), and DUNE::Maneuvers::Elevate::update().

fp32_t DUNE::IMC::DesiredPath::lradius

Loiter – Radius.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), DUNE::Maneuvers::Elevate::Elevate(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

uint32_t DUNE::IMC::DesiredPath::path_ref

Path Reference.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), DUNE::Maneuvers::Maneuver::dispatch(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

fp32_t DUNE::IMC::DesiredPath::speed

Speed.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), DUNE::Maneuvers::Elevate::Elevate(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), serializeFields(), and DUNE::Maneuvers::StationKeep::StationKeep().

uint8_t DUNE::IMC::DesiredPath::speed_units

Speed Units.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), DUNE::Maneuvers::Elevate::Elevate(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), serializeFields(), and DUNE::Maneuvers::StationKeep::StationKeep().

fp64_t DUNE::IMC::DesiredPath::start_lat

Start Point – Latitude WGS-84.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

fp64_t DUNE::IMC::DesiredPath::start_lon

Start Point – WGS-84 Longitude.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

fp32_t DUNE::IMC::DesiredPath::start_z

Start Point – Z Reference.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

uint8_t DUNE::IMC::DesiredPath::start_z_units

Start Point – Z Units.

Referenced by clear(), DUNE::Control::PathController::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

Collaboration diagram for DUNE::IMC::DesiredPath: