JAUS::RejectControl Class Reference

This message is used to notify a component that control has been released (response code = 0), or request to control could not be processed (response code = 1). More...

#include <rejectcontrol.h>

Inheritance diagram for JAUS::RejectControl:

List of all members.

Public Types
enum	Response { ControlReleased = 0, NotAvailable }
Public Member Functions
	RejectControl (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	RejectControl (const RejectControl &message)
	Copy constructor.
	~RejectControl ()
	Destructor.
Byte	SetResponseCode (const Response code)
Byte	GetResponseCode () 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.
RejectControl &	operator= (const RejectControl &message)
	Sets equal to.
Protected Attributes
Response	mResponseCode
	Response code.

---

Detailed Description

This message is used to notify a component that control has been released (response code = 0), or request to control could not be processed (response code = 1).

Definition at line 56 of file rejectcontrol.h.

---

Member Enumeration Documentation

enum JAUS::RejectControl::Response

Enumerator:

ControlReleased
NotAvailable

Definition at line 60 of file rejectcontrol.h.

---

Constructor & Destructor Documentation

RejectControl::RejectControl	(	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 53 of file rejectcontrol.cpp.

RejectControl::RejectControl

(

const RejectControl &

message )

Copy constructor.

Definition at line 64 of file rejectcontrol.cpp.

RejectControl::~RejectControl

(

)

Destructor.

Definition at line 75 of file rejectcontrol.cpp.

---

Member Function Documentation

void RejectControl::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 129 of file rejectcontrol.cpp.

virtual Message* JAUS::RejectControl::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 73 of file rejectcontrol.h.

virtual UShort JAUS::RejectControl::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 77 of file rejectcontrol.h.

virtual std::string JAUS::RejectControl::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file rejectcontrol.h.

virtual UInt JAUS::RejectControl::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 74 of file rejectcontrol.h.

virtual UInt JAUS::RejectControl::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 76 of file rejectcontrol.h.

virtual UInt JAUS::RejectControl::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file rejectcontrol.h.

Byte JAUS::RejectControl::GetResponseCode

(

)

const [inline]

Definition at line 69 of file rejectcontrol.h.

virtual bool JAUS::RejectControl::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 70 of file rejectcontrol.h.

virtual bool JAUS::RejectControl::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file rejectcontrol.h.

RejectControl & RejectControl::operator=

(

const RejectControl &

message )

Sets equal to.

Definition at line 167 of file rejectcontrol.cpp.

int RejectControl::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 113 of file rejectcontrol.cpp.

int RejectControl::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 rejectcontrol.cpp.

Byte JAUS::RejectControl::SetResponseCode

(

const Response

code )

[inline]

Definition at line 68 of file rejectcontrol.h.

int RejectControl::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 91 of file rejectcontrol.cpp.

---

Member Data Documentation

Response JAUS::RejectControl::mResponseCode [protected]

Response code.

Definition at line 84 of file rejectcontrol.h.

---

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

• jaus++/2.0/include/jaus/core/control/rejectcontrol.h
• jaus++/2.0/src/jaus/core/control/rejectcontrol.cpp