Classes | Public Member Functions | Protected Attributes

JAUS::QueryVelocityState Class Reference

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

Inheritance diagram for JAUS::QueryVelocityState:
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

 QueryVelocityState (const Address &dest=Address(), const Address &src=Address())
 Constructor, initializes default values.
 QueryVelocityState (const QueryVelocityState &message)
 Copy constructor.
 ~QueryVelocityState ()
 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 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.
QueryVelocityStateoperator= (const QueryVelocityState &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 4404: ReportVelocityState 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 queryvelocitystate.h.


Constructor & Destructor Documentation

QueryVelocityState::QueryVelocityState ( 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 55 of file queryvelocitystate.cpp.

QueryVelocityState::QueryVelocityState ( const QueryVelocityState message )

Copy constructor.

Definition at line 66 of file queryvelocitystate.cpp.

QueryVelocityState::~QueryVelocityState (  )

Destructor.

Definition at line 77 of file queryvelocitystate.cpp.


Member Function Documentation

void QueryVelocityState::ClearMessageBody (  ) [virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 131 of file queryvelocitystate.cpp.

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

Implements JAUS::Message.

Definition at line 89 of file queryvelocitystate.h.

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

Implements JAUS::Message.

Definition at line 93 of file queryvelocitystate.h.

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

Implements JAUS::Message.

Definition at line 94 of file queryvelocitystate.h.

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

Implements JAUS::Message.

Definition at line 90 of file queryvelocitystate.h.

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

Implements JAUS::Message.

Definition at line 92 of file queryvelocitystate.h.

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

Implements JAUS::Message.

Definition at line 91 of file queryvelocitystate.h.

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

Implements JAUS::Message.

Definition at line 86 of file queryvelocitystate.h.

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

Implements JAUS::Message.

Definition at line 96 of file queryvelocitystate.h.

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

Sets equal to.

Definition at line 171 of file queryvelocitystate.cpp.

int QueryVelocityState::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 115 of file queryvelocitystate.cpp.

int QueryVelocityState::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 queryvelocitystate.cpp.

void JAUS::QueryVelocityState::SetPresenceVector ( const UShort  presenceVector ) [inline]

Definition at line 85 of file queryvelocitystate.h.

int QueryVelocityState::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 93 of file queryvelocitystate.cpp.


Member Data Documentation

Bit vector for fields present.

Definition at line 100 of file queryvelocitystate.h.


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