JAUS::ReleaseControl Class Reference

This message is used to relinquish uninterruptible control of the receiving component. More...

#include <releasecontrol.h>

Inheritance diagram for JAUS::ReleaseControl:

List of all members.

Public Member Functions
	ReleaseControl (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	ReleaseControl (const ReleaseControl &message)
	Copy constructor.
	~ReleaseControl ()
	Destructor.
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.
ReleaseControl &	operator= (const ReleaseControl &message)
	Sets equal to.

---

Detailed Description

This message is used to relinquish uninterruptible control of the receiving component.

Definition at line 55 of file releasecontrol.h.

---

Constructor & Destructor Documentation

ReleaseControl::ReleaseControl	(	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 releasecontrol.cpp.

ReleaseControl::ReleaseControl

(

const ReleaseControl &

message )

Copy constructor.

Definition at line 63 of file releasecontrol.cpp.

ReleaseControl::~ReleaseControl

(

)

Destructor.

Definition at line 74 of file releasecontrol.cpp.

---

Member Function Documentation

void ReleaseControl::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 118 of file releasecontrol.cpp.

virtual Message* JAUS::ReleaseControl::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 64 of file releasecontrol.h.

virtual UShort JAUS::ReleaseControl::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 68 of file releasecontrol.h.

virtual std::string JAUS::ReleaseControl::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file releasecontrol.h.

virtual UInt JAUS::ReleaseControl::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 65 of file releasecontrol.h.

virtual UInt JAUS::ReleaseControl::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 67 of file releasecontrol.h.

virtual UInt JAUS::ReleaseControl::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 66 of file releasecontrol.h.

virtual bool JAUS::ReleaseControl::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 61 of file releasecontrol.h.

virtual bool JAUS::ReleaseControl::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file releasecontrol.h.

ReleaseControl & ReleaseControl::operator=

(

const ReleaseControl &

message )

Sets equal to.

Definition at line 152 of file releasecontrol.cpp.

int ReleaseControl::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:

0 always.

Implements JAUS::Message.

Definition at line 107 of file releasecontrol.cpp.

int ReleaseControl::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 130 of file releasecontrol.cpp.

int ReleaseControl::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:

0 always.

Implements JAUS::Message.

Definition at line 90 of file releasecontrol.cpp.

---

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

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