JAUS::QueryIdentification Class Reference

This message is used to request the identification of a Subsystem, Node, or Component. More...

#include <queryidentification.h>

Inheritance diagram for JAUS::QueryIdentification:

List of all members.

Public Types
enum	Type {   Reserved = 0, SystemIdentification, SubsystemIdentification, NodeIdentification,   ComponentIdentification }
Public Member Functions
	QueryIdentification (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	QueryIdentification (const QueryIdentification &message)
	Copy constructor.
	~QueryIdentification ()
	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
QueryIdentification &	operator= (const QueryIdentification &message)
	Sets equal to.
Protected Attributes
Type	mQueryType
	Query filter for requested event details.

---

Detailed Description

This message is used to request the identification of a Subsystem, Node, or Component.

Definition at line 55 of file queryidentification.h.

---

Member Enumeration Documentation

enum JAUS::QueryIdentification::Type

Enumerator:

Reserved
SystemIdentification
SubsystemIdentification
NodeIdentification
ComponentIdentification

Definition at line 59 of file queryidentification.h.

---

Constructor & Destructor Documentation

QueryIdentification::QueryIdentification	(	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 queryidentification.cpp.

QueryIdentification::QueryIdentification

(

const QueryIdentification &

message )

Copy constructor.

Definition at line 64 of file queryidentification.cpp.

QueryIdentification::~QueryIdentification

(

)

Destructor.

Definition at line 76 of file queryidentification.cpp.

---

Member Function Documentation

void QueryIdentification::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 127 of file queryidentification.cpp.

virtual Message* JAUS::QueryIdentification::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 75 of file queryidentification.h.

virtual UShort JAUS::QueryIdentification::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 79 of file queryidentification.h.

virtual std::string JAUS::QueryIdentification::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 80 of file queryidentification.h.

virtual UInt JAUS::QueryIdentification::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 76 of file queryidentification.h.

virtual UInt JAUS::QueryIdentification::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 78 of file queryidentification.h.

virtual UInt JAUS::QueryIdentification::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 77 of file queryidentification.h.

Type JAUS::QueryIdentification::GetQueryType

(

)

const [inline]

Definition at line 70 of file queryidentification.h.

virtual bool JAUS::QueryIdentification::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 72 of file queryidentification.h.

virtual bool JAUS::QueryIdentification::IsLargeDataSet

(

const unsigned int

maxPayloadSize )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 82 of file queryidentification.h.

QueryIdentification & QueryIdentification::operator=

(

const QueryIdentification &

message )

Sets equal to.

Definition at line 138 of file queryidentification.cpp.

int QueryIdentification::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 queryidentification.cpp.

void JAUS::QueryIdentification::SetQueryType

(

const Type

queryType )

[inline]

Definition at line 71 of file queryidentification.h.

int QueryIdentification::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 queryidentification.cpp.

---

Member Data Documentation

Type JAUS::QueryIdentification::mQueryType [protected]

Query filter for requested event details.

Definition at line 85 of file queryidentification.h.

---

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

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