openjaus::mobility::ReportGlobalPose Class Reference

ReportGlobalPose Message Implementation. More...

#include <ReportGlobalPose.h>

Inherits openjaus::model::Message.

List of all members.

Public Member Functions
	ReportGlobalPose ()
	ReportGlobalPose (model::Message *message)
	~ReportGlobalPose ()
virtual int	to (system::Buffer *dst)
	Pack this message to the given openjaus::system::Buffer.
virtual int	from (system::Buffer *src)
	Unpack this message from the given openjaus::system::Buffer.
virtual int	length ()
	Get the number of bytes this message would occupy in a serialized buffer.
std::string	toXml (unsigned char level=0) const
	Used to serialize the runtime state of the message to an XML format.
void	setPresenceVector (uint16_t value)
uint16_t	getPresenceVector (void) const
bool	isLatitudeEnabled (void) const
void	enableLatitude (void)
void	disableLatitude (void)
bool	isLongitudeEnabled (void) const
void	enableLongitude (void)
void	disableLongitude (void)
bool	isAltitudeEnabled (void) const
void	enableAltitude (void)
void	disableAltitude (void)
bool	isPositionRmsEnabled (void) const
void	enablePositionRms (void)
void	disablePositionRms (void)
bool	isRollEnabled (void) const
void	enableRoll (void)
void	disableRoll (void)
bool	isPitchEnabled (void) const
void	enablePitch (void)
void	disablePitch (void)
bool	isYawEnabled (void) const
void	enableYaw (void)
void	disableYaw (void)
bool	isAttitudeRmsEnabled (void) const
void	enableAttitudeRms (void)
void	disableAttitudeRms (void)
bool	isTimeStampEnabled (void) const
void	enableTimeStamp (void)
void	disableTimeStamp (void)
double	getLatitude_deg (void)
void	setLatitude_deg (double value)
double	getLongitude_deg (void)
void	setLongitude_deg (double value)
double	getAltitude_m (void)
void	setAltitude_m (double value)
double	getPositionRms_m (void)
void	setPositionRms_m (double value)
double	getRoll_rad (void)
void	setRoll_rad (double value)
double	getPitch_rad (void)
void	setPitch_rad (double value)
double	getYaw_rad (void)
void	setYaw_rad (double value)
double	getAttitudeRms_rad (void)
void	setAttitudeRms_rad (double value)
JausTimeStampBitField &	getTimeStamp (void)
Static Public Attributes
static const uint16_t	ID = 0x4402
Private Types
enum	pvEnum {   LATITUDE_DEG = 0, LONGITUDE_DEG = 1, ALTITUDE_M = 2, POSITIONRMS_M = 3,   ROLL_RAD = 4, PITCH_RAD = 5, YAW_RAD = 6, ATTITUDERMS_RAD = 7,   TIMESTAMP = 8 }
Private Attributes
JausLatitudeScaledInteger	latitude_deg
JausLongitudeScaledInteger	longitude_deg
JausAltitudeScaledInteger	altitude_m
LocalPositionRmsScaledInteger	positionRms_m
OrientationScaledInteger	roll_rad
OrientationScaledInteger	pitch_rad
OrientationScaledInteger	yaw_rad
OrientationRmsScaledInteger	attitudeRms_rad
JausTimeStampBitField	timeStamp
uint16_t	presenceVector

---

Detailed Description

This message is used to provide the receiver the position and attitude of the platform. The position of the platform is given in latitude, longitude, and altitude, in accordance with the WGS 84 standard. All times are in Coordinated Universal Time (UTC). The message data and mapping of the presence vector for this message are identical to ID 0402h: SetGlobalPose.

---

Member Enumeration Documentation

enum openjaus::mobility::ReportGlobalPose::pvEnum [private]

Enumerator:

LATITUDE_DEG
LONGITUDE_DEG
ALTITUDE_M
POSITIONRMS_M
ROLL_RAD
PITCH_RAD
YAW_RAD
ATTITUDERMS_RAD
TIMESTAMP

---

Constructor & Destructor Documentation

openjaus::mobility::ReportGlobalPose::ReportGlobalPose

(

)

openjaus::mobility::ReportGlobalPose::ReportGlobalPose

(

model::Message *

message

)

openjaus::mobility::ReportGlobalPose::~ReportGlobalPose

(

)

---

Member Function Documentation

void openjaus::mobility::ReportGlobalPose::disableAltitude

(

void

)

void openjaus::mobility::ReportGlobalPose::disableAttitudeRms

(

void

)

void openjaus::mobility::ReportGlobalPose::disableLatitude

(

void

)

void openjaus::mobility::ReportGlobalPose::disableLongitude

(

void

)

void openjaus::mobility::ReportGlobalPose::disablePitch

(

void

)

void openjaus::mobility::ReportGlobalPose::disablePositionRms

(

void

)

void openjaus::mobility::ReportGlobalPose::disableRoll

(

void

)

void openjaus::mobility::ReportGlobalPose::disableTimeStamp

(

void

)

void openjaus::mobility::ReportGlobalPose::disableYaw

(

void

)

void openjaus::mobility::ReportGlobalPose::enableAltitude

(

void

)

void openjaus::mobility::ReportGlobalPose::enableAttitudeRms

(

void

)

void openjaus::mobility::ReportGlobalPose::enableLatitude

(

void

)

void openjaus::mobility::ReportGlobalPose::enableLongitude

(

void

)

void openjaus::mobility::ReportGlobalPose::enablePitch

(

void

)

void openjaus::mobility::ReportGlobalPose::enablePositionRms

(

void

)

void openjaus::mobility::ReportGlobalPose::enableRoll

(

void

)

void openjaus::mobility::ReportGlobalPose::enableTimeStamp

(

void

)

void openjaus::mobility::ReportGlobalPose::enableYaw

(

void

)

int openjaus::mobility::ReportGlobalPose::from

(

system::Buffer *

src

)

[virtual]

src - The source openjaus::system::Buffer from which this message will be unpacked.

Returns:

The number of bytes unpacked from the source buffer

Reimplemented from openjaus::model::Message.

double openjaus::mobility::ReportGlobalPose::getAltitude_m

(

void

)

double openjaus::mobility::ReportGlobalPose::getAttitudeRms_rad

(

void

)

double openjaus::mobility::ReportGlobalPose::getLatitude_deg

(

void

)

double openjaus::mobility::ReportGlobalPose::getLongitude_deg

(

void

)

double openjaus::mobility::ReportGlobalPose::getPitch_rad

(

void

)

double openjaus::mobility::ReportGlobalPose::getPositionRms_m

(

void

)

uint16_t openjaus::mobility::ReportGlobalPose::getPresenceVector

(

void

)

const

double openjaus::mobility::ReportGlobalPose::getRoll_rad

(

void

)

JausTimeStampBitField & openjaus::mobility::ReportGlobalPose::getTimeStamp

(

void

)

double openjaus::mobility::ReportGlobalPose::getYaw_rad

(

void

)

bool openjaus::mobility::ReportGlobalPose::isAltitudeEnabled

(

void

)

const

bool openjaus::mobility::ReportGlobalPose::isAttitudeRmsEnabled

(

void

)

const

bool openjaus::mobility::ReportGlobalPose::isLatitudeEnabled

(

void

)

const

bool openjaus::mobility::ReportGlobalPose::isLongitudeEnabled

(

void

)

const

bool openjaus::mobility::ReportGlobalPose::isPitchEnabled

(

void

)

const

bool openjaus::mobility::ReportGlobalPose::isPositionRmsEnabled

(

void

)

const

bool openjaus::mobility::ReportGlobalPose::isRollEnabled

(

void

)

const

bool openjaus::mobility::ReportGlobalPose::isTimeStampEnabled

(

void

)

const

bool openjaus::mobility::ReportGlobalPose::isYawEnabled

(

void

)

const

int openjaus::mobility::ReportGlobalPose::length

(

void

)

[virtual]

The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

void openjaus::mobility::ReportGlobalPose::setAltitude_m

(

double

value

)

void openjaus::mobility::ReportGlobalPose::setAttitudeRms_rad

(

double

value

)

void openjaus::mobility::ReportGlobalPose::setLatitude_deg

(

double

value

)

void openjaus::mobility::ReportGlobalPose::setLongitude_deg

(

double

value

)

void openjaus::mobility::ReportGlobalPose::setPitch_rad

(

double

value

)

void openjaus::mobility::ReportGlobalPose::setPositionRms_m

(

double

value

)

void openjaus::mobility::ReportGlobalPose::setPresenceVector

(

uint16_t

value

)

void openjaus::mobility::ReportGlobalPose::setRoll_rad

(

double

value

)

void openjaus::mobility::ReportGlobalPose::setYaw_rad

(

double

value

)

int openjaus::mobility::ReportGlobalPose::to

(

system::Buffer *

dst

)

[virtual]

dst - The destination openjaus::system::Buffer to which this message will be packed.

Returns:

The number of bytes packed into the destination buffer

Reimplemented from openjaus::model::Message.

std::string openjaus::mobility::ReportGlobalPose::toXml

(

unsigned char

level = 0

)

const

level - Used to determine how many tabs are inserted per line for pretty formating.

Returns:

The serialized XML string

---

Member Data Documentation

JausAltitudeScaledInteger openjaus::mobility::ReportGlobalPose::altitude_m [private]

OrientationRmsScaledInteger openjaus::mobility::ReportGlobalPose::attitudeRms_rad [private]

const uint16_t openjaus::mobility::ReportGlobalPose::ID = 0x4402 [static]

JausLatitudeScaledInteger openjaus::mobility::ReportGlobalPose::latitude_deg [private]

JausLongitudeScaledInteger openjaus::mobility::ReportGlobalPose::longitude_deg [private]

OrientationScaledInteger openjaus::mobility::ReportGlobalPose::pitch_rad [private]

LocalPositionRmsScaledInteger openjaus::mobility::ReportGlobalPose::positionRms_m [private]

uint16_t openjaus::mobility::ReportGlobalPose::presenceVector [private]

OrientationScaledInteger openjaus::mobility::ReportGlobalPose::roll_rad [private]

JausTimeStampBitField openjaus::mobility::ReportGlobalPose::timeStamp [private]

Reimplemented from openjaus::model::Trigger.

OrientationScaledInteger openjaus::mobility::ReportGlobalPose::yaw_rad [private]

---

The documentation for this class was generated from the following files:

• include/openjaus/mobility/Triggers/ReportGlobalPose.h
• src/openjaus/mobility/Triggers/ReportGlobalPose.cpp