JAUS::ReportConfiguration Class Reference

This message shall provide the receiver a table of all existing components located on the source's subsystem or node depending on the value of Query Configuration message. More...

#include <reportconfiguration.h>

Inheritance diagram for JAUS::ReportConfiguration:

List of all members.

Classes
class	Record
	Component information record for report. More...
Public Types
typedef std::map< Byte, Record::List >	Nodes
Public Member Functions
	ReportConfiguration (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	ReportConfiguration (const ReportConfiguration &message)
	Copy constructor.
	~ReportConfiguration ()
	Destructor.
Nodes *	GetNodes ()
const Nodes *	GetNodes () 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) const
ReportConfiguration &	operator= (const ReportConfiguration &message)
	Sets equal to.
Protected Attributes
Nodes	mNodes
	Node configuration data.

---

Detailed Description

This message shall provide the receiver a table of all existing components located on the source's subsystem or node depending on the value of Query Configuration message.

Definition at line 57 of file reportconfiguration.h.

---

Member Typedef Documentation

typedef std::map<Byte, Record::List > JAUS::ReportConfiguration::Nodes

Definition at line 89 of file reportconfiguration.h.

---

Constructor & Destructor Documentation

ReportConfiguration::ReportConfiguration	(	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 reportconfiguration.cpp.

ReportConfiguration::ReportConfiguration

(

const ReportConfiguration &

message )

Copy constructor.

Definition at line 64 of file reportconfiguration.cpp.

ReportConfiguration::~ReportConfiguration

(

)

Destructor.

Definition at line 75 of file reportconfiguration.cpp.

---

Member Function Documentation

void ReportConfiguration::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 169 of file reportconfiguration.cpp.

virtual Message* JAUS::ReportConfiguration::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 98 of file reportconfiguration.h.

virtual UShort JAUS::ReportConfiguration::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 102 of file reportconfiguration.h.

virtual std::string JAUS::ReportConfiguration::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 103 of file reportconfiguration.h.

const Nodes* JAUS::ReportConfiguration::GetNodes

(

)

const [inline]

Definition at line 94 of file reportconfiguration.h.

Nodes* JAUS::ReportConfiguration::GetNodes

(

)

[inline]

Definition at line 93 of file reportconfiguration.h.

virtual UInt JAUS::ReportConfiguration::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 99 of file reportconfiguration.h.

virtual UInt JAUS::ReportConfiguration::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 101 of file reportconfiguration.h.

virtual UInt JAUS::ReportConfiguration::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 100 of file reportconfiguration.h.

virtual bool JAUS::ReportConfiguration::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 95 of file reportconfiguration.h.

virtual bool JAUS::ReportConfiguration::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 105 of file reportconfiguration.h.

ReportConfiguration & ReportConfiguration::operator=

(

const ReportConfiguration &

message )

Sets equal to.

Definition at line 180 of file reportconfiguration.cpp.

int ReportConfiguration::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 133 of file reportconfiguration.cpp.

int ReportConfiguration::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 92 of file reportconfiguration.cpp.

---

Member Data Documentation

Nodes JAUS::ReportConfiguration::mNodes [protected]

Node configuration data.

Definition at line 108 of file reportconfiguration.h.

---

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

• jaus++/2.0/include/jaus/core/discovery/reportconfiguration.h
• jaus++/2.0/src/jaus/core/discovery/reportconfiguration.cpp