JAUS::QueryLocalPose Class Reference

This message shall cause the receiving component to reply to the requestor with a ID 4403h: ReportLocalPose 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 <querylocalpose.h>

Inheritance diagram for JAUS::QueryLocalPose:

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
	QueryLocalPose (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryLocalPose (const QueryLocalPose &message)
	Copy constructor.
	~QueryLocalPose ()
	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.
QueryLocalPose &	operator= (const QueryLocalPose &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 4403h: ReportLocalPose 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 querylocalpose.h.

---

Constructor & Destructor Documentation

QueryLocalPose::QueryLocalPose	(	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 querylocalpose.cpp.

QueryLocalPose::QueryLocalPose

(

const QueryLocalPose &

message )

Copy constructor.

Definition at line 66 of file querylocalpose.cpp.

QueryLocalPose::~QueryLocalPose

(

)

Destructor.

Definition at line 77 of file querylocalpose.cpp.

---

Member Function Documentation

void QueryLocalPose::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 131 of file querylocalpose.cpp.

virtual Message* JAUS::QueryLocalPose::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 89 of file querylocalpose.h.

virtual UShort JAUS::QueryLocalPose::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 93 of file querylocalpose.h.

virtual std::string JAUS::QueryLocalPose::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 94 of file querylocalpose.h.

virtual UInt JAUS::QueryLocalPose::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 90 of file querylocalpose.h.

virtual UInt JAUS::QueryLocalPose::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 92 of file querylocalpose.h.

virtual UInt JAUS::QueryLocalPose::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 91 of file querylocalpose.h.

virtual bool JAUS::QueryLocalPose::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 86 of file querylocalpose.h.

virtual bool JAUS::QueryLocalPose::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 96 of file querylocalpose.h.

QueryLocalPose & QueryLocalPose::operator=

(

const QueryLocalPose &

message )

Sets equal to.

Definition at line 171 of file querylocalpose.cpp.

int QueryLocalPose::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 querylocalpose.cpp.

int QueryLocalPose::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 querylocalpose.cpp.

void JAUS::QueryLocalPose::SetPresenceVector

(

const UShort

presenceVector )

[inline]

Definition at line 85 of file querylocalpose.h.

int QueryLocalPose::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 querylocalpose.cpp.

---

Member Data Documentation

UShort JAUS::QueryLocalPose::mPresenceVector [protected]

Bit vector for fields present.

Definition at line 100 of file querylocalpose.h.

---

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

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