Classes | Public Member Functions | Protected Attributes

JAUS::QueryGlobalWaypoint Class Reference

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

#include <queryglobalwaypoint.h>

Inheritance diagram for JAUS::QueryGlobalWaypoint:
JAUS::Message

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

 QueryGlobalWaypoint (const Address &dest=Address(), const Address &src=Address())
 Constructor, initializes default values.
 QueryGlobalWaypoint (const QueryGlobalWaypoint &message)
 Copy constructor.
 ~QueryGlobalWaypoint ()
 Destructor.
void SetPresenceVector (const Byte 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 MessageClone () 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.
QueryGlobalWaypointoperator= (const QueryGlobalWaypoint &message)
 Sets equal to.

Protected Attributes

Byte mPresenceVector
 Bit vector for fields present.

Detailed Description

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

Definition at line 59 of file queryglobalwaypoint.h.


Constructor & Destructor Documentation

QueryGlobalWaypoint::QueryGlobalWaypoint ( const Address dest = Address(),
const Address src = Address() 
)

Constructor, initializes default values.

Parameters:
[in]srcSource ID of message sender.
[in]destDestination ID of message.

Definition at line 53 of file queryglobalwaypoint.cpp.

QueryGlobalWaypoint::QueryGlobalWaypoint ( const QueryGlobalWaypoint message )

Copy constructor.

Definition at line 64 of file queryglobalwaypoint.cpp.

QueryGlobalWaypoint::~QueryGlobalWaypoint (  )

Destructor.

Definition at line 75 of file queryglobalwaypoint.cpp.


Member Function Documentation

void QueryGlobalWaypoint::ClearMessageBody (  ) [virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 129 of file queryglobalwaypoint.cpp.

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

Implements JAUS::Message.

Definition at line 86 of file queryglobalwaypoint.h.

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

Implements JAUS::Message.

Definition at line 90 of file queryglobalwaypoint.h.

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

Implements JAUS::Message.

Definition at line 91 of file queryglobalwaypoint.h.

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

Implements JAUS::Message.

Definition at line 87 of file queryglobalwaypoint.h.

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

Implements JAUS::Message.

Definition at line 89 of file queryglobalwaypoint.h.

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

Implements JAUS::Message.

Definition at line 88 of file queryglobalwaypoint.h.

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

Implements JAUS::Message.

Definition at line 83 of file queryglobalwaypoint.h.

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

Implements JAUS::Message.

Definition at line 93 of file queryglobalwaypoint.h.

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

Sets equal to.

Definition at line 166 of file queryglobalwaypoint.cpp.

int QueryGlobalWaypoint::ReadMessageBody ( const Packet packet ) [virtual]

Reads message payload from the packet.

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

Parameters:
[in]packetPacket containing message payload data to read.
Returns:
-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 113 of file queryglobalwaypoint.cpp.

int QueryGlobalWaypoint::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 142 of file queryglobalwaypoint.cpp.

void JAUS::QueryGlobalWaypoint::SetPresenceVector ( const Byte  presenceVector ) [inline]

Definition at line 82 of file queryglobalwaypoint.h.

int QueryGlobalWaypoint::WriteMessageBody ( Packet packet ) const [virtual]

Writes message payload to the packet.

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

Parameters:
[out]packetPacket to write payload to.
Returns:
-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 91 of file queryglobalwaypoint.cpp.


Member Data Documentation

Bit vector for fields present.

Definition at line 97 of file queryglobalwaypoint.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines