JAUS::QueryGlobalPose Class Reference

This message shall cause the receiving component to reply to the requestor with a ID 4402h: ReportGlobalPose message. A logical AND shall be performed on the requested presence vector and that representating the available fields from the responder. The resulting message shall contain the fields indicated by the result of this lobical AND operation. More...

#include <queryglobalpose.h>

Inheritance diagram for JAUS::QueryGlobalPose:

List of all members.

Classes
class	PresenceVector
	This class contains bit masks for bitwise operations on the presence vector for this message. More...
Public Member Functions
	QueryGlobalPose (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryGlobalPose (const QueryGlobalPose &message)
	Copy constructor.
	~QueryGlobalPose ()
	Destructor.
void	SetPresenceVector (const UShort presenceVector)
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.
QueryGlobalPose &	operator= (const QueryGlobalPose &message)
	Sets equal to.
Protected Attributes
UShort	mPresenceVector
	Bit vector for fields present.

---

Detailed Description

This message shall cause the receiving component to reply to the requestor with a ID 4402h: ReportGlobalPose message. A logical AND shall be performed on the requested presence vector and that representating the available fields from the responder. The resulting message shall contain the fields indicated by the result of this lobical AND operation.

Definition at line 59 of file queryglobalpose.h.

---

Constructor & Destructor Documentation

QueryGlobalPose::QueryGlobalPose	(	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 55 of file queryglobalpose.cpp.

QueryGlobalPose::QueryGlobalPose

(

const QueryGlobalPose &

message )

Copy constructor.

Definition at line 66 of file queryglobalpose.cpp.

QueryGlobalPose::~QueryGlobalPose

(

)

Destructor.

Definition at line 77 of file queryglobalpose.cpp.

---

Member Function Documentation

void QueryGlobalPose::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 131 of file queryglobalpose.cpp.

virtual Message* JAUS::QueryGlobalPose::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 89 of file queryglobalpose.h.

virtual UShort JAUS::QueryGlobalPose::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 93 of file queryglobalpose.h.

virtual std::string JAUS::QueryGlobalPose::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 94 of file queryglobalpose.h.

virtual UInt JAUS::QueryGlobalPose::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 90 of file queryglobalpose.h.

virtual UInt JAUS::QueryGlobalPose::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 92 of file queryglobalpose.h.

virtual UInt JAUS::QueryGlobalPose::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 91 of file queryglobalpose.h.

virtual bool JAUS::QueryGlobalPose::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 86 of file queryglobalpose.h.

virtual bool JAUS::QueryGlobalPose::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 96 of file queryglobalpose.h.

QueryGlobalPose & QueryGlobalPose::operator=

(

const QueryGlobalPose &

message )

Sets equal to.

Definition at line 171 of file queryglobalpose.cpp.

int QueryGlobalPose::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 115 of file queryglobalpose.cpp.

int QueryGlobalPose::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 144 of file queryglobalpose.cpp.

void JAUS::QueryGlobalPose::SetPresenceVector

(

const UShort

presenceVector )

[inline]

Definition at line 85 of file queryglobalpose.h.

int QueryGlobalPose::WriteMessageBody

(

Packet &

packet )

const [virtual]

Writes message payload to the packet.

Message contents are written to the packet following the JAUS standard.

Parameters:

[out]

packet

Packet to write payload to.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 93 of file queryglobalpose.cpp.

---

Member Data Documentation

UShort JAUS::QueryGlobalPose::mPresenceVector [protected]

Bit vector for fields present.

Definition at line 100 of file queryglobalpose.h.

---

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

• jaus++/2.0/include/jaus/mobility/sensors/queryglobalpose.h
• jaus++/2.0/src/jaus/mobility/sensors/queryglobalpose.cpp