JAUS::QueryConfiguration Class Reference

This message is used to request the configuration of a subsystem or node. For example, to get the complete configuration of a subsystem, QueryType will be set to SubystemConfiguration. More...

#include <queryconfiguration.h>

Inheritance diagram for JAUS::QueryConfiguration:

List of all members.

Public Types
enum	Type { Reserved = 1, SubsystemConfiguration, NodeConfiguration }
Public Member Functions
	QueryConfiguration (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryConfiguration (const QueryConfiguration &message)
	Copy constructor.
	~QueryConfiguration ()
	Destructor.
Type	GetQueryType () const
void	SetQueryType (const Type queryType)
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
QueryConfiguration &	operator= (const QueryConfiguration &message)
	Sets equal to.
Protected Attributes
Type	mQueryType
	Query filter for requested event details.

---

Detailed Description

This message is used to request the configuration of a subsystem or node. For example, to get the complete configuration of a subsystem, QueryType will be set to SubystemConfiguration.

Definition at line 56 of file queryconfiguration.h.

---

Member Enumeration Documentation

enum JAUS::QueryConfiguration::Type

Enumerator:

Reserved
SubsystemConfiguration
NodeConfiguration

Definition at line 60 of file queryconfiguration.h.

---

Constructor & Destructor Documentation

QueryConfiguration::QueryConfiguration	(	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 queryconfiguration.cpp.

QueryConfiguration::QueryConfiguration

(

const QueryConfiguration &

message )

Copy constructor.

Definition at line 64 of file queryconfiguration.cpp.

QueryConfiguration::~QueryConfiguration

(

)

Destructor.

Definition at line 76 of file queryconfiguration.cpp.

---

Member Function Documentation

void QueryConfiguration::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 127 of file queryconfiguration.cpp.

virtual Message* JAUS::QueryConfiguration::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 74 of file queryconfiguration.h.

virtual UShort JAUS::QueryConfiguration::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file queryconfiguration.h.

virtual std::string JAUS::QueryConfiguration::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file queryconfiguration.h.

virtual UInt JAUS::QueryConfiguration::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file queryconfiguration.h.

virtual UInt JAUS::QueryConfiguration::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 77 of file queryconfiguration.h.

virtual UInt JAUS::QueryConfiguration::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 76 of file queryconfiguration.h.

Type JAUS::QueryConfiguration::GetQueryType

(

)

const [inline]

Definition at line 69 of file queryconfiguration.h.

virtual bool JAUS::QueryConfiguration::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file queryconfiguration.h.

virtual bool JAUS::QueryConfiguration::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 81 of file queryconfiguration.h.

QueryConfiguration & QueryConfiguration::operator=

(

const QueryConfiguration &

message )

Sets equal to.

Definition at line 138 of file queryconfiguration.cpp.

int QueryConfiguration::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 queryconfiguration.cpp.

void JAUS::QueryConfiguration::SetQueryType

(

const Type

queryType )

[inline]

Definition at line 70 of file queryconfiguration.h.

int QueryConfiguration::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 93 of file queryconfiguration.cpp.

---

Member Data Documentation

Type JAUS::QueryConfiguration::mQueryType [protected]

Query filter for requested event details.

Definition at line 84 of file queryconfiguration.h.

---

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

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