JAUS::ReportServices Class Reference

This message allows a component to publish its capabilities, according to the Service Dictionary presented. If a component ID is specified in the RA, it may report only one service beyond the core message support, and this service must be equal to the component ID. If a component ID is not listed in the RA, it can report any number of services. More...

#include <reportservices.h>

Inheritance diagram for JAUS::ReportServices:

List of all members.

Classes
class	Record
	Component information record for report. More...
Public Types
typedef std::map< Byte, Record::List >	Services
Public Member Functions
	ReportServices (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	ReportServices (const ReportServices &message)
	Copy constructor.
	~ReportServices ()
	Destructor.
Services *	GetServices ()
const Services *	GetServices () 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
ReportServices &	operator= (const ReportServices &message)
	Sets equal to.
Protected Attributes
Services	mServices
	The services list.

---

Detailed Description

This message allows a component to publish its capabilities, according to the Service Dictionary presented. If a component ID is specified in the RA, it may report only one service beyond the core message support, and this service must be equal to the component ID. If a component ID is not listed in the RA, it can report any number of services.

Definition at line 60 of file reportservices.h.

---

Member Typedef Documentation

typedef std::map<Byte, Record::List > JAUS::ReportServices::Services

Definition at line 94 of file reportservices.h.

---

Constructor & Destructor Documentation

ReportServices::ReportServices	(	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 reportservices.cpp.

ReportServices::ReportServices

(

const ReportServices &

message )

Copy constructor.

Definition at line 64 of file reportservices.cpp.

ReportServices::~ReportServices

(

)

Destructor.

Definition at line 75 of file reportservices.cpp.

---

Member Function Documentation

void ReportServices::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 182 of file reportservices.cpp.

virtual Message* JAUS::ReportServices::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 103 of file reportservices.h.

virtual UShort JAUS::ReportServices::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 107 of file reportservices.h.

virtual std::string JAUS::ReportServices::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 108 of file reportservices.h.

virtual UInt JAUS::ReportServices::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 104 of file reportservices.h.

virtual UInt JAUS::ReportServices::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 106 of file reportservices.h.

virtual UInt JAUS::ReportServices::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 105 of file reportservices.h.

const Services* JAUS::ReportServices::GetServices

(

)

const [inline]

Definition at line 99 of file reportservices.h.

Services* JAUS::ReportServices::GetServices

(

)

[inline]

Definition at line 98 of file reportservices.h.

virtual bool JAUS::ReportServices::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 100 of file reportservices.h.

bool ReportServices::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [virtual]

Returns:

True if the contents of the message will be larger than maximum payload size, otherwise false.

Implements JAUS::Message.

Definition at line 194 of file reportservices.cpp.

ReportServices & ReportServices::operator=

(

const ReportServices &

message )

Sets equal to.

Definition at line 227 of file reportservices.cpp.

int ReportServices::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 139 of file reportservices.cpp.

int ReportServices::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 reportservices.cpp.

---

Member Data Documentation

Services JAUS::ReportServices::mServices [protected]

The services list.

Definition at line 113 of file reportservices.h.

---

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

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