JAUS::SetAuthority Class Reference

This message shall set the command authority of the receiving component. The authority bits range in value from 0 to 255 with 255 being the highest. More...

#include <setauthority.h>

Inheritance diagram for JAUS::SetAuthority:

List of all members.

Public Member Functions
	SetAuthority (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	SetAuthority (const SetAuthority &message)
	Copy constructor.
	~SetAuthority ()
	Destructor.
void	SetAuthorityCode (const Byte code)
Byte	GetAuthorityCode () 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.
SetAuthority &	operator= (const SetAuthority &message)
	Sets equal to.
Protected Attributes
Byte	mAuthorityCode
	Authority value of sending component [0,255].

---

Detailed Description

This message shall set the command authority of the receiving component. The authority bits range in value from 0 to 255 with 255 being the highest.

Definition at line 56 of file setauthority.h.

---

Constructor & Destructor Documentation

SetAuthority::SetAuthority	(	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 setauthority.cpp.

SetAuthority::SetAuthority

(

const SetAuthority &

message )

Copy constructor.

Definition at line 64 of file setauthority.cpp.

SetAuthority::~SetAuthority

(

)

Destructor.

Definition at line 75 of file setauthority.cpp.

---

Member Function Documentation

void SetAuthority::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 129 of file setauthority.cpp.

virtual Message* JAUS::SetAuthority::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 67 of file setauthority.h.

Byte JAUS::SetAuthority::GetAuthorityCode

(

)

const [inline]

Definition at line 63 of file setauthority.h.

virtual UShort JAUS::SetAuthority::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file setauthority.h.

virtual std::string JAUS::SetAuthority::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 72 of file setauthority.h.

virtual UInt JAUS::SetAuthority::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 68 of file setauthority.h.

virtual UInt JAUS::SetAuthority::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 70 of file setauthority.h.

virtual UInt JAUS::SetAuthority::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file setauthority.h.

virtual bool JAUS::SetAuthority::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 64 of file setauthority.h.

virtual bool JAUS::SetAuthority::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 74 of file setauthority.h.

SetAuthority & SetAuthority::operator=

(

const SetAuthority &

message )

Sets equal to.

Definition at line 166 of file setauthority.cpp.

int SetAuthority::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 setauthority.cpp.

int SetAuthority::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 setauthority.cpp.

void JAUS::SetAuthority::SetAuthorityCode

(

const Byte

code )

[inline]

Definition at line 62 of file setauthority.h.

int SetAuthority::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 setauthority.cpp.

---

Member Data Documentation

Byte JAUS::SetAuthority::mAuthorityCode [protected]

Authority value of sending component [0,255].

Definition at line 78 of file setauthority.h.

---

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

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