This message shall cause the receiving component to reply to the requestor with a ID 4415h : ReportVelocityCommand Message. Field #2 specifies the fields to be returned in the ReportVelocityCommand message. More...

#include <queryvelocitycommand.h>

Inheritance diagram for JAUS::QueryVelocityCommand:

List of all members.

Classes
class	PresenceVector
	This class contains bit masks for bitwise operations on the presence vector for this message. More...
Public Types
enum	Command { SetCurrentCommand = 0, SetMaximumAllowedValues, SetMinimumAllowedValues, SetDefaultCommand }
Public Member Functions
	QueryVelocityCommand (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryVelocityCommand (const QueryVelocityCommand &message)
	Copy constructor.
	~QueryVelocityCommand ()
	Destructor.
void	SetPresenceVector (const Byte presenceVector)
Byte	SetCommandType (const Command type)
Byte	GetCommandType () const
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.
QueryVelocityCommand &	operator= (const QueryVelocityCommand &message)
	Sets equal to.
Protected Attributes
Byte	mPresenceVector
	Bit vector for fields present.
Command	mCommandType
	CommandType.

Detailed Description

This message shall cause the receiving component to reply to the requestor with a ID 4415h : ReportVelocityCommand Message. Field #2 specifies the fields to be returned in the ReportVelocityCommand message.

Definition at line 57 of file queryvelocitycommand.h.

Member Enumeration Documentation

enum JAUS::QueryVelocityCommand::Command

Enumerator:

SetCurrentCommand
SetMaximumAllowedValues
SetMinimumAllowedValues
SetDefaultCommand

Definition at line 78 of file queryvelocitycommand.h.

Constructor & Destructor Documentation

QueryVelocityCommand::QueryVelocityCommand	(	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 queryvelocitycommand.cpp.

QueryVelocityCommand::QueryVelocityCommand ( const QueryVelocityCommand & message )

Copy constructor.

Definition at line 67 of file queryvelocitycommand.cpp.

QueryVelocityCommand::~QueryVelocityCommand ( )

Destructor.

Definition at line 78 of file queryvelocitycommand.cpp.

Member Function Documentation

void QueryVelocityCommand::ClearMessageBody ( ) [virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 138 of file queryvelocitycommand.cpp.

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

Implements JAUS::Message.

Definition at line 94 of file queryvelocitycommand.h.

Byte JAUS::QueryVelocityCommand::GetCommandType ( ) const [inline]

Definition at line 90 of file queryvelocitycommand.h.

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

Implements JAUS::Message.

Definition at line 98 of file queryvelocitycommand.h.

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

Implements JAUS::Message.

Definition at line 99 of file queryvelocitycommand.h.

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

Implements JAUS::Message.

Definition at line 95 of file queryvelocitycommand.h.

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

Implements JAUS::Message.

Definition at line 97 of file queryvelocitycommand.h.

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

Implements JAUS::Message.

Definition at line 96 of file queryvelocitycommand.h.

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

Implements JAUS::Message.

Definition at line 91 of file queryvelocitycommand.h.

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

Implements JAUS::Message.

Definition at line 101 of file queryvelocitycommand.h.

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

Sets equal to.

Definition at line 178 of file queryvelocitycommand.cpp.

int QueryVelocityCommand::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 119 of file queryvelocitycommand.cpp.

int QueryVelocityCommand::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 152 of file queryvelocitycommand.cpp.

Byte JAUS::QueryVelocityCommand::SetCommandType ( const Command type ) [inline]

Definition at line 89 of file queryvelocitycommand.h.

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

Definition at line 88 of file queryvelocitycommand.h.

int QueryVelocityCommand::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 94 of file queryvelocitycommand.cpp.

Member Data Documentation

Command JAUS::QueryVelocityCommand::mCommandType [protected]

CommandType.

Definition at line 106 of file queryvelocitycommand.h.

Byte JAUS::QueryVelocityCommand::mPresenceVector [protected]

Bit vector for fields present.

Definition at line 105 of file queryvelocitycommand.h.

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

jaus++/2.0/include/jaus/mobility/drivers/queryvelocitycommand.h
jaus++/2.0/src/jaus/mobility/drivers/queryvelocitycommand.cpp

JAUS::QueryVelocityCommand Class Reference

Classes

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation