SetGlobalPose Message Implementation. More...

#include <SetGlobalPose.h>

Public Member Functions
	SetGlobalPose ()

	SetGlobalPose (model::Message *message)

	~SetGlobalPose ()

virtual uint64	to (system::BufferWriter &dst) const
	Pack this message to the given openjaus::system::Buffer. More...

virtual uint64	from (system::BufferReader &src)
	Unpack this message from the given openjaus::system::Buffer. More...

virtual uint64	length () const
	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	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)

bool	setLatitude_deg (double value)

double	getLongitude_deg (void)

bool	setLongitude_deg (double value)

double	getAltitude_m (void)

bool	setAltitude_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)

Public Member Functions inherited from openjaus::transport::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
	Transportable ()

virtual	~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 = 0x0402

static const uint16_t	PV_NO_FIELDS = 0x0

static const uint16_t	PV_LATITUDE = 0x1

static const uint16_t	PV_LONGITUDE = 0x2

static const uint16_t	PV_ALTITUDE = 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 uint16_t	PV_ALL_FIELDS = PV_NO_FIELDS \| PV_LATITUDE \| PV_LONGITUDE \| PV_ALTITUDE \| PV_POSITIONRMS \| PV_ROLL \| PV_PITCH \| PV_YAW \| PV_ATTITUDERMS \| PV_TIMESTAMP

static const double	LATITUDE_MIN_VALUE = -90.0

static const double	LATITUDE_MAX_VALUE = 90.0

static const double	LONGITUDE_MIN_VALUE = -180.0

static const double	LONGITUDE_MAX_VALUE = 180.0

static const double	ALTITUDE_MIN_VALUE = -10000.0

static const double	ALTITUDE_MAX_VALUE = 35000.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

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

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

Additional Inherited Members
Protected Member Functions inherited from openjaus::transport::Wrapper
	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 set the global pose values.

Constructor & Destructor Documentation

◆ SetGlobalPose() [1/2]

openjaus::mobility_v1_0::SetGlobalPose::SetGlobalPose ( )

◆ SetGlobalPose() [2/2]

openjaus::mobility_v1_0::SetGlobalPose::SetGlobalPose ( model::Message * message )

◆ ~SetGlobalPose()

openjaus::mobility_v1_0::SetGlobalPose::~SetGlobalPose ( )

Member Function Documentation

◆ disableAltitude()

void openjaus::mobility_v1_0::SetGlobalPose::disableAltitude ( void )

◆ disableAttitudeRms()

void openjaus::mobility_v1_0::SetGlobalPose::disableAttitudeRms ( void )

◆ disableLatitude()

void openjaus::mobility_v1_0::SetGlobalPose::disableLatitude ( void )

◆ disableLongitude()

void openjaus::mobility_v1_0::SetGlobalPose::disableLongitude ( void )

◆ disablePitch()

void openjaus::mobility_v1_0::SetGlobalPose::disablePitch ( void )

◆ disablePositionRms()

void openjaus::mobility_v1_0::SetGlobalPose::disablePositionRms ( void )

◆ disableRoll()

void openjaus::mobility_v1_0::SetGlobalPose::disableRoll ( void )

◆ disableTimeStamp()

void openjaus::mobility_v1_0::SetGlobalPose::disableTimeStamp ( void )

◆ disableYaw()

void openjaus::mobility_v1_0::SetGlobalPose::disableYaw ( void )

◆ enableAltitude()

void openjaus::mobility_v1_0::SetGlobalPose::enableAltitude ( void )

◆ enableAttitudeRms()

void openjaus::mobility_v1_0::SetGlobalPose::enableAttitudeRms ( void )

◆ enableLatitude()

void openjaus::mobility_v1_0::SetGlobalPose::enableLatitude ( void )

◆ enableLongitude()

void openjaus::mobility_v1_0::SetGlobalPose::enableLongitude ( void )

◆ enablePitch()

void openjaus::mobility_v1_0::SetGlobalPose::enablePitch ( void )

◆ enablePositionRms()

void openjaus::mobility_v1_0::SetGlobalPose::enablePositionRms ( void )

◆ enableRoll()

void openjaus::mobility_v1_0::SetGlobalPose::enableRoll ( void )

◆ enableTimeStamp()

void openjaus::mobility_v1_0::SetGlobalPose::enableTimeStamp ( void )

◆ enableYaw()

void openjaus::mobility_v1_0::SetGlobalPose::enableYaw ( void )

◆ from()

uint64 openjaus::mobility_v1_0::SetGlobalPose::from ( system::BufferReader & 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::model::Message.

◆ getAltitude_m()

double openjaus::mobility_v1_0::SetGlobalPose::getAltitude_m ( void )

◆ getAttitudeRms_rad()

double openjaus::mobility_v1_0::SetGlobalPose::getAttitudeRms_rad ( void )

◆ getLatitude_deg()

double openjaus::mobility_v1_0::SetGlobalPose::getLatitude_deg ( void )

◆ getLongitude_deg()

double openjaus::mobility_v1_0::SetGlobalPose::getLongitude_deg ( void )

◆ getPitch_rad()

double openjaus::mobility_v1_0::SetGlobalPose::getPitch_rad ( void )

◆ getPositionRms_m()

double openjaus::mobility_v1_0::SetGlobalPose::getPositionRms_m ( void )

◆ getPresenceVector()

uint16_t openjaus::mobility_v1_0::SetGlobalPose::getPresenceVector ( void ) const

◆ getRoll_rad()

double openjaus::mobility_v1_0::SetGlobalPose::getRoll_rad ( void )

◆ getTimeStamp()

model::fields::TimeStamp & openjaus::mobility_v1_0::SetGlobalPose::getTimeStamp ( void )

◆ getYaw_rad()

double openjaus::mobility_v1_0::SetGlobalPose::getYaw_rad ( void )

◆ isAltitudeEnabled()

bool openjaus::mobility_v1_0::SetGlobalPose::isAltitudeEnabled ( void ) const

◆ isAttitudeRmsEnabled()

bool openjaus::mobility_v1_0::SetGlobalPose::isAttitudeRmsEnabled ( void ) const

◆ isLatitudeEnabled()

bool openjaus::mobility_v1_0::SetGlobalPose::isLatitudeEnabled ( void ) const

◆ isLongitudeEnabled()

bool openjaus::mobility_v1_0::SetGlobalPose::isLongitudeEnabled ( void ) const

◆ isPitchEnabled()

bool openjaus::mobility_v1_0::SetGlobalPose::isPitchEnabled ( void ) const

◆ isPositionRmsEnabled()

bool openjaus::mobility_v1_0::SetGlobalPose::isPositionRmsEnabled ( void ) const

◆ isRollEnabled()

bool openjaus::mobility_v1_0::SetGlobalPose::isRollEnabled ( void ) const

◆ isTimeStampEnabled()

bool openjaus::mobility_v1_0::SetGlobalPose::isTimeStampEnabled ( void ) const

◆ isYawEnabled()

bool openjaus::mobility_v1_0::SetGlobalPose::isYawEnabled ( void ) const

◆ length()

uint64 openjaus::mobility_v1_0::SetGlobalPose::length ( void ) const

virtual

Returns: The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

◆ setAltitude_m()

bool openjaus::mobility_v1_0::SetGlobalPose::setAltitude_m ( double value )

◆ setAttitudeRms_rad()

bool openjaus::mobility_v1_0::SetGlobalPose::setAttitudeRms_rad ( double value )

◆ setLatitude_deg()

bool openjaus::mobility_v1_0::SetGlobalPose::setLatitude_deg ( double value )

◆ setLongitude_deg()

bool openjaus::mobility_v1_0::SetGlobalPose::setLongitude_deg ( double value )

◆ setPitch_rad()

bool openjaus::mobility_v1_0::SetGlobalPose::setPitch_rad ( double value )

◆ setPositionRms_m()

bool openjaus::mobility_v1_0::SetGlobalPose::setPositionRms_m ( double value )

◆ setPresenceVector()

void openjaus::mobility_v1_0::SetGlobalPose::setPresenceVector ( uint16_t value )

◆ setRoll_rad()

bool openjaus::mobility_v1_0::SetGlobalPose::setRoll_rad ( double value )

◆ setYaw_rad()

bool openjaus::mobility_v1_0::SetGlobalPose::setYaw_rad ( double value )

◆ to()

uint64 openjaus::mobility_v1_0::SetGlobalPose::to ( system::BufferWriter & dst ) const

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::model::Message.

◆ toString()

std::string openjaus::mobility_v1_0::SetGlobalPose::toString ( ) const

virtual

Returns: The string

Reimplemented from openjaus::model::Message.

◆ toXml()

std::string openjaus::mobility_v1_0::SetGlobalPose::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 SetGlobalPose &	object
	)

friend

◆ operator<< [2/2]

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

static

◆ yaw_rad

OrientationScaledInteger openjaus::mobility_v1_0::SetGlobalPose::yaw_rad

private

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

include/openjaus/mobility_v1_0/Triggers/SetGlobalPose.h
src/openjaus/mobility_v1_0/Triggers/SetGlobalPose.cpp

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

model::fields::TimeStamp	timeStamp

uint16_t	presenceVector

Public Member Functions

Static Public Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SetGlobalPose() [1/2]

◆ SetGlobalPose() [2/2]

◆ ~SetGlobalPose()

Member Function Documentation

◆ disableAltitude()

◆ disableAttitudeRms()

◆ disableLatitude()

◆ disableLongitude()

◆ disablePitch()

◆ disablePositionRms()

◆ disableRoll()

◆ disableTimeStamp()

◆ disableYaw()

◆ enableAltitude()

◆ enableAttitudeRms()

◆ enableLatitude()

◆ enableLongitude()

◆ enablePitch()

◆ enablePositionRms()

◆ enableRoll()

◆ enableTimeStamp()

◆ enableYaw()

◆ from()

◆ getAltitude_m()

◆ getAttitudeRms_rad()

◆ getLatitude_deg()

◆ getLongitude_deg()

◆ getPitch_rad()

◆ getPositionRms_m()

◆ getPresenceVector()

◆ getRoll_rad()

◆ getTimeStamp()

◆ getYaw_rad()

◆ isAltitudeEnabled()

◆ isAttitudeRmsEnabled()

◆ isLatitudeEnabled()

◆ isLongitudeEnabled()

◆ isPitchEnabled()

◆ isPositionRmsEnabled()

◆ isRollEnabled()

◆ isTimeStampEnabled()

◆ isYawEnabled()

◆ length()

◆ setAltitude_m()

◆ setAttitudeRms_rad()

◆ setLatitude_deg()

◆ setLongitude_deg()

◆ setPitch_rad()

◆ setPositionRms_m()

◆ setPresenceVector()

◆ setRoll_rad()

◆ setYaw_rad()

◆ to()

◆ toString()

◆ toXml()

Friends And Related Function Documentation

◆ operator<< [1/2]

◆ operator<< [2/2]

Member Data Documentation

◆ altitude_m

◆ ALTITUDE_MAX_VALUE

◆ ALTITUDE_MIN_VALUE

◆ ATTITUDERMS_MAX_VALUE

◆ ATTITUDERMS_MIN_VALUE

◆ attitudeRms_rad

◆ ID

◆ latitude_deg

◆ LATITUDE_MAX_VALUE

◆ LATITUDE_MIN_VALUE

◆ longitude_deg

◆ LONGITUDE_MAX_VALUE

◆ LONGITUDE_MIN_VALUE

◆ PITCH_MAX_VALUE