JAUS::QueryServices Class Reference

This message allows a component to request the service information of an entire subsystem or node, or a single component. The corresponding Report Services message will respond with service information only for new component implementations. It will not report service information for legacy component implementations. More...

#include <queryservices.h>

Inheritance diagram for JAUS::QueryServices:

List of all members.

Public Types
typedef std::map< Byte, std::vector< Byte > >	List
Public Member Functions
	QueryServices (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryServices (const QueryServices &message)
	Copy constructor.
	~QueryServices ()
	Destructor.
List *	GetNodeList ()
const List *	GetNodeList () 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
QueryServices &	operator= (const QueryServices &message)
	Sets equal to.
Protected Attributes
List	mNodeList
	Nodes and components to get data from.

---

Detailed Description

This message allows a component to request the service information of an entire subsystem or node, or a single component. The corresponding Report Services message will respond with service information only for new component implementations. It will not report service information for legacy component implementations.

Definition at line 60 of file queryservices.h.

---

Member Typedef Documentation

typedef std::map<Byte, std::vector<Byte> > JAUS::QueryServices::List

Reimplemented from JAUS::Message.

Definition at line 63 of file queryservices.h.

---

Constructor & Destructor Documentation

QueryServices::QueryServices	(	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 52 of file queryservices.cpp.

QueryServices::QueryServices

(

const QueryServices &

message )

Copy constructor.

Definition at line 63 of file queryservices.cpp.

QueryServices::~QueryServices

(

)

Destructor.

Definition at line 74 of file queryservices.cpp.

---

Member Function Documentation

void QueryServices::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 169 of file queryservices.cpp.

virtual Message* JAUS::QueryServices::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 72 of file queryservices.h.

virtual UShort JAUS::QueryServices::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 76 of file queryservices.h.

virtual std::string JAUS::QueryServices::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 77 of file queryservices.h.

const List* JAUS::QueryServices::GetNodeList

(

)

const [inline]

Definition at line 68 of file queryservices.h.

List* JAUS::QueryServices::GetNodeList

(

)

[inline]

Definition at line 67 of file queryservices.h.

virtual UInt JAUS::QueryServices::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 73 of file queryservices.h.

virtual UInt JAUS::QueryServices::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file queryservices.h.

virtual UInt JAUS::QueryServices::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 74 of file queryservices.h.

virtual bool JAUS::QueryServices::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file queryservices.h.

virtual bool JAUS::QueryServices::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file queryservices.h.

QueryServices & QueryServices::operator=

(

const QueryServices &

message )

Sets equal to.

Definition at line 181 of file queryservices.cpp.

int QueryServices::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 queryservices.cpp.

int QueryServices::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 queryservices.cpp.

---

Member Data Documentation

List JAUS::QueryServices::mNodeList [protected]

Nodes and components to get data from.

Definition at line 82 of file queryservices.h.

---

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

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