openjaus::mobility::ReportLocalPose Class Reference

ReportLocalPose Message Implementation. More...

#include <ReportLocalPose.h>

Inherits openjaus::model::Message.

Public Member Functions
	ReportLocalPose ()
	ReportLocalPose (model::Message *message)
	~ReportLocalPose ()
virtual int	to (system::Buffer *dst)
	Pack this message to the given openjaus::system::Buffer. More...
virtual int	from (system::Buffer *src)
	Unpack this message from the given openjaus::system::Buffer. More...
virtual int	length ()
	Get the number of bytes this message would occupy in a serialized buffer. More...
std::string	toXml (unsigned char ojIndentLevel=0) const
	Used to serialize the runtime state of the message to an XML format. More...
std::string	toString () const
	Returns a string populated with the Message name and ID More...
void	setPresenceVector (uint16_t value)
uint16_t	getPresenceVector (void) const
bool	isXEnabled (void) const
void	enableX (void)
void	disableX (void)
bool	isYEnabled (void) const
void	enableY (void)
void	disableY (void)
bool	isZEnabled (void) const
void	enableZ (void)
void	disableZ (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	getX_m (void)
bool	setX_m (double value)
double	getY_m (void)
bool	setY_m (double value)
double	getZ_m (void)
bool	setZ_m (double value)
double	getPositionRms_m (void)
bool	setPositionRms_m (double value)
double	getRoll_rad (void)
bool	setRoll_rad (double value)
double	getPitch_rad (void)
bool	setPitch_rad (double value)
double	getYaw_rad (void)
bool	setYaw_rad (double value)
double	getAttitudeRms_rad (void)
bool	setAttitudeRms_rad (double value)
model::fields::TimeStamp &	getTimeStamp (void)
Public Member Functions inherited from openjaus::model::Message
	Message ()
virtual	~Message ()
	Message (Message *message)
int	to (system::Buffer *dst)
	Operation to. More...
int	from (system::Buffer *src)
	Operation from. More...
Public Member Functions inherited from openjaus::transport::Wrapper
	Wrapper ()
virtual	~Wrapper ()
AckNakType	getAckNak () const
	Accessor to get the value of ackNak. More...
bool	setAckNak (AckNakType ackNak)
	Accessor to set value of ackNak. More...
bool	isCompressible () const
	Accessor to get the value of compressible. More...
bool	setCompressible (bool compressible)
	Accessor to set value of compressible. More...
bool	isMustArrive () const
	Accessor to get the value of mustArrive. More...
bool	setMustArrive (bool mustArrive)
	Accessor to set value of mustArrive. More...
uint16_t	getSequenceNumber () const
	Accessor to get the value of sequenceNumber. More...
bool	setSequenceNumber (uint16_t sequenceNumber)
	Accessor to set value of sequenceNumber. More...
WrapperType	getType () const
	Accessor to get the value of type. More...
bool	setType (WrapperType type)
	Accessor to set value of type. More...
Priority	getPriority () const
	Accessor to get the value of priority. More...
bool	setPriority (Priority priority)
	Accessor to set value of priority. More...
BroadcastType	getBroadcastFlag () const
	Accessor to get the value of broadcastFlag. More...
bool	setBroadcastFlag (BroadcastType broadcastFlag)
	Accessor to set value of broadcastFlag. More...
LargeMessageType	getLargeMessageFlag () const
	Accessor to get the value of largeMessageFlag. More...
bool	setLargeMessageFlag (LargeMessageType largeMessageFlag)
	Accessor to set value of largeMessageFlag. More...
const Address &	getDestination () const
	Accessor to get the value of destination. More...
bool	setDestination (const Address &destination)
	Accessor to set value of destination. More...
system::Transportable *	getPayload () const
	Accessor to get the value of payload. More...
bool	setPayload (system::Transportable *payload)
	Accessor to set value of payload. More...
const Address &	getSource () const
	Accessor to get the value of source. More...
bool	setSource (const Address &source)
	Accessor to set value of source. More...
TransportData *	getTransportData () const
	Accessor to get the value of transportData. More...
bool	setTransportData (TransportData *transportData)
	Accessor to set value of transportData. More...
virtual int	prioritizedValue ()
	Operation prioritizedValue. More...
virtual Wrapper *	clone ()
Public Member Functions inherited from openjaus::system::Transportable
virtual	~Transportable ()
	Transportable ()
Public Member Functions inherited from openjaus::system::Prioritized
virtual	~Prioritized ()
Public Member Functions inherited from openjaus::model::Trigger
	Trigger ()
virtual	~Trigger ()
double	getTriggerTimestamp_sec () const
	Accessor to get the value of triggerTimestamp_sec. More...
bool	setTriggerTimestamp_sec (double triggerTimestamp_sec)
	Accessor to set value of triggerTimestamp_sec. More...
uint32_t	getId () const
	Accessor to get the value of id. More...
bool	setId (uint32_t id)
	Accessor to set value of id. More...
std::string	idString ()
	Operation idString. More...

Static Public Attributes
static const uint16_t	ID = 0x4403
static const uint16_t	PV_ALL_FIELDS = 0xFFFF
static const uint16_t	PV_NO_FIELDS = 0x0
static const uint16_t	PV_X = 0x1
static const uint16_t	PV_Y = 0x2
static const uint16_t	PV_Z = 0x4
static const uint16_t	PV_POSITIONRMS = 0x8
static const uint16_t	PV_ROLL = 0x10
static const uint16_t	PV_PITCH = 0x20
static const uint16_t	PV_YAW = 0x40
static const uint16_t	PV_ATTITUDERMS = 0x80
static const uint16_t	PV_TIMESTAMP = 0x100
static const double	X_MIN_VALUE = -100000.0
static const double	X_MAX_VALUE = 100000.0
static const double	Y_MIN_VALUE = -100000.0
static const double	Y_MAX_VALUE = 100000.0
static const double	Z_MIN_VALUE = -100000.0
static const double	Z_MAX_VALUE = 100000.0
static const double	POSITIONRMS_MIN_VALUE = 0.0
static const double	POSITIONRMS_MAX_VALUE = 100.0
static const double	ROLL_MIN_VALUE = -3.141592653589793
static const double	ROLL_MAX_VALUE = 3.141592653589793
static const double	PITCH_MIN_VALUE = -3.141592653589793
static const double	PITCH_MAX_VALUE = 3.141592653589793
static const double	YAW_MIN_VALUE = -3.141592653589793
static const double	YAW_MAX_VALUE = 3.141592653589793
static const double	ATTITUDERMS_MIN_VALUE = 0.0
static const double	ATTITUDERMS_MAX_VALUE = 3.141592653589793

Private Attributes
LocalPositionScaledInteger	x_m
LocalPositionScaledInteger	y_m
LocalPositionScaledInteger	z_m
LocalPositionRmsScaledInteger	positionRms_m
OrientationScaledInteger	roll_rad
OrientationScaledInteger	pitch_rad
OrientationScaledInteger	yaw_rad
OrientationRmsScaledInteger	attitudeRms_rad
model::fields::TimeStamp	timeStamp
uint16_t	presenceVector

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const ReportLocalPose &object)
	OStream operator for Message object More...
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const ReportLocalPose *object)
	OStream operator for Message pointer More...

Additional Inherited Members
Protected Member Functions inherited from openjaus::transport::Wrapper
	Wrapper (const Wrapper &wrapper)
Protected Attributes inherited from openjaus::transport::Wrapper
AckNakType	ackNak
bool	compressible
bool	mustArrive
uint16_t	sequenceNumber
WrapperType	type
Priority	priority
BroadcastType	broadcastFlag
LargeMessageType	largeMessageFlag
Address	destination
system::Transportable *	payload
Address	source
TransportData *	transportData
Protected Attributes inherited from openjaus::model::Trigger
double	triggerTimestamp_sec
uint32_t	id

Detailed Description

This message is used to provide the receiver the position and attitude of the platform relative to a local reference frame. All times are in Coordinated Universal Time (UTC). The message data and mapping of the presence vector for this message are identical to ID 0403h: SetLocalPose.

Constructor & Destructor Documentation

ReportLocalPose() [1/2]

openjaus::mobility::ReportLocalPose::ReportLocalPose

(

)

ReportLocalPose() [2/2]

openjaus::mobility::ReportLocalPose::ReportLocalPose

(

model::Message *

message

)

~ReportLocalPose()

openjaus::mobility::ReportLocalPose::~ReportLocalPose

(

)

Member Function Documentation

disableAttitudeRms()

void openjaus::mobility::ReportLocalPose::disableAttitudeRms

(

void

)

disablePitch()

void openjaus::mobility::ReportLocalPose::disablePitch

(

void

)

disablePositionRms()

void openjaus::mobility::ReportLocalPose::disablePositionRms

(

void

)

disableRoll()

void openjaus::mobility::ReportLocalPose::disableRoll

(

void

)

disableTimeStamp()

void openjaus::mobility::ReportLocalPose::disableTimeStamp

(

void

)

disableX()

void openjaus::mobility::ReportLocalPose::disableX

(

void

)

disableY()

void openjaus::mobility::ReportLocalPose::disableY

(

void

)

disableYaw()

void openjaus::mobility::ReportLocalPose::disableYaw

(

void

)

disableZ()

void openjaus::mobility::ReportLocalPose::disableZ

(

void

)

enableAttitudeRms()

void openjaus::mobility::ReportLocalPose::enableAttitudeRms

(

void

)

enablePitch()

void openjaus::mobility::ReportLocalPose::enablePitch

(

void

)

enablePositionRms()

void openjaus::mobility::ReportLocalPose::enablePositionRms

(

void

)

enableRoll()

void openjaus::mobility::ReportLocalPose::enableRoll

(

void

)

enableTimeStamp()

void openjaus::mobility::ReportLocalPose::enableTimeStamp

(

void

)

enableX()

void openjaus::mobility::ReportLocalPose::enableX

(

void

)

enableY()

void openjaus::mobility::ReportLocalPose::enableY

(

void

)

enableYaw()

void openjaus::mobility::ReportLocalPose::enableYaw

(

void

)

enableZ()

void openjaus::mobility::ReportLocalPose::enableZ

(

void

)

from()

int openjaus::mobility::ReportLocalPose::from ( system::Buffer *  src )

virtual

Parameters

[in]

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::transport::Wrapper.

getAttitudeRms_rad()

double openjaus::mobility::ReportLocalPose::getAttitudeRms_rad

(

void

)

getPitch_rad()

double openjaus::mobility::ReportLocalPose::getPitch_rad

(

void

)

getPositionRms_m()

double openjaus::mobility::ReportLocalPose::getPositionRms_m

(

void

)

getPresenceVector()

uint16_t openjaus::mobility::ReportLocalPose::getPresenceVector

(

void

)

const

getRoll_rad()

double openjaus::mobility::ReportLocalPose::getRoll_rad

(

void

)

getTimeStamp()

model::fields::TimeStamp & openjaus::mobility::ReportLocalPose::getTimeStamp

(

void

)

getX_m()

double openjaus::mobility::ReportLocalPose::getX_m

(

void

)

getY_m()

double openjaus::mobility::ReportLocalPose::getY_m

(

void

)

getYaw_rad()

double openjaus::mobility::ReportLocalPose::getYaw_rad

(

void

)

getZ_m()

double openjaus::mobility::ReportLocalPose::getZ_m

(

void

)

isAttitudeRmsEnabled()

bool openjaus::mobility::ReportLocalPose::isAttitudeRmsEnabled

(

void

)

const

isPitchEnabled()

bool openjaus::mobility::ReportLocalPose::isPitchEnabled

(

void

)

const

isPositionRmsEnabled()

bool openjaus::mobility::ReportLocalPose::isPositionRmsEnabled

(

void

)

const

isRollEnabled()

bool openjaus::mobility::ReportLocalPose::isRollEnabled

(

void

)

const

isTimeStampEnabled()

bool openjaus::mobility::ReportLocalPose::isTimeStampEnabled

(

void

)

const

isXEnabled()

bool openjaus::mobility::ReportLocalPose::isXEnabled

(

void

)

const

isYawEnabled()

bool openjaus::mobility::ReportLocalPose::isYawEnabled

(

void

)

const

isYEnabled()

bool openjaus::mobility::ReportLocalPose::isYEnabled

(

void

)

const

isZEnabled()

bool openjaus::mobility::ReportLocalPose::isZEnabled

(

void

)

const

length()

int openjaus::mobility::ReportLocalPose::length ( void  )

virtual

Returns

The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

setAttitudeRms_rad()

bool openjaus::mobility::ReportLocalPose::setAttitudeRms_rad

(

double

value

)

setPitch_rad()

bool openjaus::mobility::ReportLocalPose::setPitch_rad

(

double

value

)

setPositionRms_m()

bool openjaus::mobility::ReportLocalPose::setPositionRms_m

(

double

value

)

setPresenceVector()

void openjaus::mobility::ReportLocalPose::setPresenceVector

(

uint16_t

value

)

setRoll_rad()

bool openjaus::mobility::ReportLocalPose::setRoll_rad

(

double

value

)

setX_m()

bool openjaus::mobility::ReportLocalPose::setX_m

(

double

value

)

setY_m()

bool openjaus::mobility::ReportLocalPose::setY_m

(

double

value

)

setYaw_rad()

bool openjaus::mobility::ReportLocalPose::setYaw_rad

(

double

value

)

setZ_m()

bool openjaus::mobility::ReportLocalPose::setZ_m

(

double

value

)

to()

int openjaus::mobility::ReportLocalPose::to ( system::Buffer *  dst )

virtual

Parameters

[out]

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::transport::Wrapper.

toString()

std::string openjaus::mobility::ReportLocalPose::toString ( ) const

virtual

Returns

The string

Reimplemented from openjaus::model::Message.

toXml()

std::string openjaus::mobility::ReportLocalPose::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Parameters

[in]

ojIndentLevel

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

Returns

The serialized XML string

Friends And Related Function Documentation

operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const ReportLocalPose &  object  )

friend

operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const ReportLocalPose *  object  )

friend

Member Data Documentation

ATTITUDERMS_MAX_VALUE

const double openjaus::mobility::ReportLocalPose::ATTITUDERMS_MAX_VALUE = 3.141592653589793

static

ATTITUDERMS_MIN_VALUE

const double openjaus::mobility::ReportLocalPose::ATTITUDERMS_MIN_VALUE = 0.0

static

attitudeRms_rad

OrientationRmsScaledInteger openjaus::mobility::ReportLocalPose::attitudeRms_rad

private

ID

const uint16_t openjaus::mobility::ReportLocalPose::ID = 0x4403

static

PITCH_MAX_VALUE

const double openjaus::mobility::ReportLocalPose::PITCH_MAX_VALUE = 3.141592653589793

static

PITCH_MIN_VALUE

const double openjaus::mobility::ReportLocalPose::PITCH_MIN_VALUE = -3.141592653589793

static

pitch_rad

OrientationScaledInteger openjaus::mobility::ReportLocalPose::pitch_rad

private

positionRms_m

LocalPositionRmsScaledInteger openjaus::mobility::ReportLocalPose::positionRms_m

private

POSITIONRMS_MAX_VALUE

const double openjaus::mobility::ReportLocalPose::POSITIONRMS_MAX_VALUE = 100.0

static

POSITIONRMS_MIN_VALUE

const double openjaus::mobility::ReportLocalPose::POSITIONRMS_MIN_VALUE = 0.0

static

presenceVector

uint16_t openjaus::mobility::ReportLocalPose::presenceVector

private

PV_ALL_FIELDS

const uint16_t openjaus::mobility::ReportLocalPose::PV_ALL_FIELDS = 0xFFFF

static

PV_ATTITUDERMS

const uint16_t openjaus::mobility::ReportLocalPose::PV_ATTITUDERMS = 0x80

static

PV_NO_FIELDS

const uint16_t openjaus::mobility::ReportLocalPose::PV_NO_FIELDS = 0x0

static

PV_PITCH

const uint16_t openjaus::mobility::ReportLocalPose::PV_PITCH = 0x20

static

PV_POSITIONRMS

const uint16_t openjaus::mobility::ReportLocalPose::PV_POSITIONRMS = 0x8

static

PV_ROLL

const uint16_t openjaus::mobility::ReportLocalPose::PV_ROLL = 0x10

static

PV_TIMESTAMP

const uint16_t openjaus::mobility::ReportLocalPose::PV_TIMESTAMP = 0x100

static

PV_X

const uint16_t openjaus::mobility::ReportLocalPose::PV_X = 0x1

static

PV_Y

const uint16_t openjaus::mobility::ReportLocalPose::PV_Y = 0x2

static

PV_YAW

const uint16_t openjaus::mobility::ReportLocalPose::PV_YAW = 0x40

static

PV_Z

const uint16_t openjaus::mobility::ReportLocalPose::PV_Z = 0x4

static

ROLL_MAX_VALUE

const double openjaus::mobility::ReportLocalPose::ROLL_MAX_VALUE = 3.141592653589793

static

ROLL_MIN_VALUE

const double openjaus::mobility::ReportLocalPose::ROLL_MIN_VALUE = -3.141592653589793

static

roll_rad

OrientationScaledInteger openjaus::mobility::ReportLocalPose::roll_rad

private

timeStamp

model::fields::TimeStamp openjaus::mobility::ReportLocalPose::timeStamp

private

x_m

LocalPositionScaledInteger openjaus::mobility::ReportLocalPose::x_m

private

X_MAX_VALUE

const double openjaus::mobility::ReportLocalPose::X_MAX_VALUE = 100000.0

static

X_MIN_VALUE

const double openjaus::mobility::ReportLocalPose::X_MIN_VALUE = -100000.0

static

y_m

LocalPositionScaledInteger openjaus::mobility::ReportLocalPose::y_m

private

Y_MAX_VALUE

const double openjaus::mobility::ReportLocalPose::Y_MAX_VALUE = 100000.0

static

Y_MIN_VALUE

const double openjaus::mobility::ReportLocalPose::Y_MIN_VALUE = -100000.0

static

YAW_MAX_VALUE

const double openjaus::mobility::ReportLocalPose::YAW_MAX_VALUE = 3.141592653589793

static

YAW_MIN_VALUE

const double openjaus::mobility::ReportLocalPose::YAW_MIN_VALUE = -3.141592653589793

static

yaw_rad

OrientationScaledInteger openjaus::mobility::ReportLocalPose::yaw_rad

private

z_m

LocalPositionScaledInteger openjaus::mobility::ReportLocalPose::z_m

private

Z_MAX_VALUE

const double openjaus::mobility::ReportLocalPose::Z_MAX_VALUE = 100000.0

static

Z_MIN_VALUE

const double openjaus::mobility::ReportLocalPose::Z_MIN_VALUE = -100000.0

static

---

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

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