JAUS::QueryAccelerationLimit Class Reference

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

#include <queryaccelerationlimit.h>

Inheritance diagram for JAUS::QueryAccelerationLimit:

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 { SetMaximumAllowedValues = 0, SetMinimumAllowedValues }
Public Member Functions
	QueryAccelerationLimit (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryAccelerationLimit (const QueryAccelerationLimit &message)
	Copy constructor.
	~QueryAccelerationLimit ()
	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.
QueryAccelerationLimit &	operator= (const QueryAccelerationLimit &message)
	Sets equal to.
Protected Attributes
Byte	mPresenceVector
	Bit vector for fields present.
Command	mCommandType
	CommandType.

---

Detailed Description

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

Definition at line 57 of file queryaccelerationlimit.h.

---

Member Enumeration Documentation

enum JAUS::QueryAccelerationLimit::Command

Enumerator:

SetMaximumAllowedValues
SetMinimumAllowedValues

Definition at line 78 of file queryaccelerationlimit.h.

---

Constructor & Destructor Documentation

QueryAccelerationLimit::QueryAccelerationLimit	(	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 queryaccelerationlimit.cpp.

QueryAccelerationLimit::QueryAccelerationLimit

(

const QueryAccelerationLimit &

message )

Copy constructor.

Definition at line 67 of file queryaccelerationlimit.cpp.

QueryAccelerationLimit::~QueryAccelerationLimit

(

)

Destructor.

Definition at line 78 of file queryaccelerationlimit.cpp.

---

Member Function Documentation

void QueryAccelerationLimit::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 138 of file queryaccelerationlimit.cpp.

virtual Message* JAUS::QueryAccelerationLimit::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 92 of file queryaccelerationlimit.h.

Byte JAUS::QueryAccelerationLimit::GetCommandType

(

)

const [inline]

Definition at line 88 of file queryaccelerationlimit.h.

virtual UShort JAUS::QueryAccelerationLimit::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 96 of file queryaccelerationlimit.h.

virtual std::string JAUS::QueryAccelerationLimit::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 97 of file queryaccelerationlimit.h.

virtual UInt JAUS::QueryAccelerationLimit::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 93 of file queryaccelerationlimit.h.

virtual UInt JAUS::QueryAccelerationLimit::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 95 of file queryaccelerationlimit.h.

virtual UInt JAUS::QueryAccelerationLimit::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 94 of file queryaccelerationlimit.h.

virtual bool JAUS::QueryAccelerationLimit::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 89 of file queryaccelerationlimit.h.

virtual bool JAUS::QueryAccelerationLimit::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 99 of file queryaccelerationlimit.h.

QueryAccelerationLimit & QueryAccelerationLimit::operator=

(

const QueryAccelerationLimit &

message )

Sets equal to.

Definition at line 180 of file queryaccelerationlimit.cpp.

int QueryAccelerationLimit::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 queryaccelerationlimit.cpp.

int QueryAccelerationLimit::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 queryaccelerationlimit.cpp.

Byte JAUS::QueryAccelerationLimit::SetCommandType

(

const Command

type )

[inline]

Definition at line 87 of file queryaccelerationlimit.h.

void JAUS::QueryAccelerationLimit::SetPresenceVector

(

const Byte

presenceVector )

[inline]

Definition at line 86 of file queryaccelerationlimit.h.

int QueryAccelerationLimit::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 queryaccelerationlimit.cpp.

---

Member Data Documentation

Command JAUS::QueryAccelerationLimit::mCommandType [protected]

CommandType.

Definition at line 104 of file queryaccelerationlimit.h.

Byte JAUS::QueryAccelerationLimit::mPresenceVector [protected]

Bit vector for fields present.

Definition at line 103 of file queryaccelerationlimit.h.

---

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

• jaus++/2.0/include/jaus/mobility/drivers/queryaccelerationlimit.h
• jaus++/2.0/src/jaus/mobility/drivers/queryaccelerationlimit.cpp