This message is used to set the global pose values. More...

#include <setglobalpose.h>

Inheritance diagram for JAUS::SetGlobalPose:

Classes
class	Limits
	Contains constants for limit values of data members of class. More...
class	PresenceVector
	This class contains bit masks for bitwise operations on the presence vector for this message. More...
Public Member Functions
	SetGlobalPose (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	SetGlobalPose (const SetGlobalPose &message)
	Copy constructor.
	~SetGlobalPose ()
	Destructor.
bool	SetLatitude (const double degrees)
	Sets the latitude and updates the presence vector for the message.
bool	SetLongitude (const double degrees)
	Sets the longitude and updates the presence vector for the message.
bool	SetAltitude (const double value)
	Sets the altitude and updates the presence vector for the message.
bool	SetPositionRMS (const double value)
	Sets the Position RMS and updates the presence vector for the message.
bool	SetRoll (const double radians)
	Sets the roll and updates the presence vector for the message.
bool	SetPitch (const double radians)
	Sets the pitch value and updates the presence vector for the message.
bool	SetYaw (const double radians)
	Sets the yaw value and updates the presence vector for the message.
bool	SetAttitudeRMS (const double radians)
	Sets the attitude rms value and updates the presence vector for the message.
bool	SetTimeStamp (const Time &time)
	Sets the Time Stamp value and updates the presence vector for the message.
bool	SetPose (const Wgs &position, const Point3D &orientation, const Time &time=Time(true))
	Sets Lattitude, Longitude, Altitude, Roll, Pitch, Yaw, and Time. Overrides any existing data.
bool	SetPosition (const Wgs &position, const Time &time=Time(true))
	Sets Lattitude, Longitude, Altitude, and Time. Overrides any existing data.
bool	SetOrientation (const Point3D &orientation, const Time &time=Time(true))
	Sets Roll, Pitch, Yaw, and Time. Overrides any existing data.
double	GetLatitude () const
double	GetLongitude () const
double	GetAltitude () const
double	GetPositionRMS () const
double	GetRoll () const
double	GetPitch () const
double	GetYaw () const
double	GetAttitudeRMS () const
Time	GetTimeStamp () const
Wgs	GetPosition () const
	Gets Lattitude, Longitude, Altitude as a Point3D.
Point3D	GetOrientation () const
	Gets Roll, Pitch, Yaw as a Point3D.
virtual bool	IsCommand () const
virtual int	WriteMessageBody (Packet &packet) const
	Writes message payload to the packet.
virtual int	ReadMessageBody (const Packet &packet)
	Reads message payload from the packet.
virtual Message *	Clone () const
virtual UInt	GetPresenceVector () const
virtual UInt	GetPresenceVectorSize () const
virtual UInt	GetPresenceVectorMask () const
virtual UShort	GetMessageCodeOfResponse () const
virtual std::string	GetMessageName () const
virtual void	ClearMessageBody ()
	Clears message payload data.
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize=1437) const
virtual int	RunTestCase () const
	Runs a test case to validate the message class.
SetGlobalPose &	operator= (const SetGlobalPose &message)
	Sets equal to.
Protected Attributes
UShort	mPresenceVector
	Bit vector for fields present.
double	mLatitude
	Latitude in degrees [-90, 90].
double	mLongitude
	Longitude in degrees [-180, 180].
double	mAltitude
	Altitude in meters [-10000, 35000].
double	mPositionRMS
	Position RMS value in meters [0, 100].
double	mRoll
	Roll in radians [-PI, PI].
double	mPitch
	Pitch in radians [-PI, PI].
double	mYaw
	Yaw in radians [-PI, PI].
double	mAttitudeRMS
	Attitude RMS value in Radians [0, PI].
Time	mTimeStamp
	TimeStamp, a tuple in (ms,sec,min,hour,day)

Detailed Description

This message is used to set the global pose values.

Definition at line 55 of file setglobalpose.h.

Constructor & Destructor Documentation

SetGlobalPose::SetGlobalPose	(	const Address &	dest = `Address()`,
		const Address &	src = `Address()`
	)

Constructor, initializes default values.

Parameters:

[in]	src	Source ID of message sender.
[in]	dest	Destination ID of message.

Definition at line 68 of file setglobalpose.cpp.

SetGlobalPose::SetGlobalPose ( const SetGlobalPose & message )

Copy constructor.

Definition at line 88 of file setglobalpose.cpp.

SetGlobalPose::~SetGlobalPose ( )

Destructor.

Definition at line 99 of file setglobalpose.cpp.

Member Function Documentation

void SetGlobalPose::ClearMessageBody ( ) [virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 575 of file setglobalpose.cpp.

virtual Message* JAUS::SetGlobalPose::Clone ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 131 of file setglobalpose.h.

double JAUS::SetGlobalPose::GetAltitude ( ) const [inline]

Definition at line 119 of file setglobalpose.h.

double JAUS::SetGlobalPose::GetAttitudeRMS ( ) const [inline]

Definition at line 124 of file setglobalpose.h.

double JAUS::SetGlobalPose::GetLatitude ( ) const [inline]

Definition at line 117 of file setglobalpose.h.

double JAUS::SetGlobalPose::GetLongitude ( ) const [inline]

Definition at line 118 of file setglobalpose.h.

virtual UShort JAUS::SetGlobalPose::GetMessageCodeOfResponse ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 135 of file setglobalpose.h.

virtual std::string JAUS::SetGlobalPose::GetMessageName ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 136 of file setglobalpose.h.

Point3D SetGlobalPose::GetOrientation ( ) const

Gets Roll, Pitch, Yaw as a Point3D.

Returns:: Orientation Desired Roll(X), Pitch(Y), Yaw(Z) stored as a Point3D.

Definition at line 423 of file setglobalpose.cpp.

double JAUS::SetGlobalPose::GetPitch ( ) const [inline]

Definition at line 122 of file setglobalpose.h.

Wgs SetGlobalPose::GetPosition ( ) const

Gets Lattitude, Longitude, Altitude as a Point3D.

Returns:: Position Desired Lattitude(X), Longitude(Y), Altitude(Z) stored as a Point3D.

Definition at line 408 of file setglobalpose.cpp.

double JAUS::SetGlobalPose::GetPositionRMS ( ) const [inline]

Definition at line 120 of file setglobalpose.h.

virtual UInt JAUS::SetGlobalPose::GetPresenceVector ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 132 of file setglobalpose.h.

virtual UInt JAUS::SetGlobalPose::GetPresenceVectorMask ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 134 of file setglobalpose.h.

virtual UInt JAUS::SetGlobalPose::GetPresenceVectorSize ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 133 of file setglobalpose.h.

double JAUS::SetGlobalPose::GetRoll ( ) const [inline]

Definition at line 121 of file setglobalpose.h.

Time JAUS::SetGlobalPose::GetTimeStamp ( ) const [inline]

Definition at line 125 of file setglobalpose.h.

double JAUS::SetGlobalPose::GetYaw ( ) const [inline]

Definition at line 123 of file setglobalpose.h.

virtual bool JAUS::SetGlobalPose::IsCommand ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 128 of file setglobalpose.h.

virtual bool JAUS::SetGlobalPose::IsLargeDataSet ( const unsigned int maxPayloadSize = 1437 ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 138 of file setglobalpose.h.

SetGlobalPose & SetGlobalPose::operator= ( const SetGlobalPose & message )

Sets equal to.

Definition at line 626 of file setglobalpose.cpp.

int SetGlobalPose::ReadMessageBody ( const Packet & packet ) [virtual]

Reads message payload from the packet.

Message contents are read from the packet following the JAUS standard.

Parameters:

[in] packet Packet containing message payload data to read.

Returns:: -1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 510 of file setglobalpose.cpp.

int SetGlobalPose::RunTestCase ( ) const [virtual]

Runs a test case to validate the message class.

Returns:: 1 on success, otherwise 0.

Reimplemented from JAUS::Message.

Definition at line 597 of file setglobalpose.cpp.

bool SetGlobalPose::SetAltitude ( const double value )

Sets the altitude and updates the presence vector for the message.

Parameters:

[in] value Desired Altitude in meters [-10000, 35000].

Returns:: true on success, otherwise false.

Definition at line 156 of file setglobalpose.cpp.

bool SetGlobalPose::SetAttitudeRMS ( const double radians )

Sets the attitude rms value and updates the presence vector for the message.

Parameters:

[in] radians Desired attitude RMS in radians [0, PI].

Returns:: true on success, otherwise false.

Definition at line 263 of file setglobalpose.cpp.

bool SetGlobalPose::SetLatitude ( const double degrees )

Sets the latitude and updates the presence vector for the message.

Parameters:

[in] degrees Desired latitude in degrees [-90, 90].

Returns:: true on success, otherwise false.

Definition at line 113 of file setglobalpose.cpp.

bool SetGlobalPose::SetLongitude ( const double degrees )

Sets the longitude and updates the presence vector for the message.

Parameters:

[in] degrees Desired longitude in degrees [-180, 180].

Returns:: true on success, otherwise false.

Definition at line 134 of file setglobalpose.cpp.

bool SetGlobalPose::SetOrientation	(	const Point3D &	orientation,
		const Time &	time = `Time(true)`
	)

Sets Roll, Pitch, Yaw, and Time. Overrides any existing data.

Parameters:

[in]	orientation	Desired Roll(X), Pitch(Y), Yaw(Z) stored as a Point3D.
[in]	time	Desired Time Stamp as a JAUS::Time instance, defaulting to the current time in UTC.

Returns:: true if params are accepted, otherwise false.

Definition at line 380 of file setglobalpose.cpp.

bool SetGlobalPose::SetPitch ( const double radians )

Sets the pitch value and updates the presence vector for the message.

Parameters:

[in] radians Desired pitch in radians[-PI, PI].

Returns:: true on success, otherwise false.

Definition at line 220 of file setglobalpose.cpp.

bool SetGlobalPose::SetPose	(	const Wgs &	position,
		const Point3D &	orientation,
		const Time &	time = `Time(true)`
	)

Sets Lattitude, Longitude, Altitude, Roll, Pitch, Yaw, and Time. Overrides any existing data.

Parameters:

[in]	position	Desired Lattitude(X), Longitude(Y), Altitude(Z) stored as a Point3D.
[in]	orientation	Desired Roll(X), Pitch(Y), Yaw(Z) stored as a Point3D.
[in]	time	Desired Time Stamp as a JAUS::Time instance, defaulting to the current time in UTC.

Returns:: true if params are accepted, otherwise false.

Definition at line 307 of file setglobalpose.cpp.

bool SetGlobalPose::SetPosition	(	const Wgs &	position,
		const Time &	time = `Time(true)`
	)

Sets Lattitude, Longitude, Altitude, and Time. Overrides any existing data.

Parameters:

[in]	position	Desired Lattitude(X), Longitude(Y), Altitude(Z) stored as a Point3D.
[in]	time	Desired Time Stamp as a JAUS::Time instance, defaulting to the current time in UTC.