This message shall provide the requesting component an identification summary of the Subsystem, Node, or Component. More...

#include <reportidentification.h>

Inheritance diagram for JAUS::ReportIdentification:

List of all members.

Public Types
enum	QueryType { Reserved = 0, SystemIdentification, SubsystemIdentification, NodeIdentification, ComponentIdentification }
enum	IdentificationType { Vehicle = 10001, OCU = 20001, OtherSubsystem = 30001, Node = 40001, Payload = 50001, Component = 60001 }
Public Member Functions
	ReportIdentification (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	ReportIdentification (const ReportIdentification &message)
	Copy constructor.
	~ReportIdentification ()
	Destructor.
void	SetQueryType (const QueryType type)
void	SetType (const IdentificationType type)
bool	SetIdentification (const std::string &identification)
	Sets the identification.
QueryType	GetQueryType () const
IdentificationType	GetType () const
std::string	GetIdentification () 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
ReportIdentification &	operator= (const ReportIdentification &message)
	Sets equal to.
Protected Attributes
QueryType	mQueryType
	Type of query the report is responding to.
IdentificationType	mIdentificationType
	Type of subsystem, node type, or component type.
std::string	mIdentification
	Identification name [up to 255 characters].

Detailed Description

This message shall provide the requesting component an identification summary of the Subsystem, Node, or Component.

Definition at line 55 of file reportidentification.h.

Member Enumeration Documentation

enum JAUS::ReportIdentification::IdentificationType

Enumerator:

Vehicle
OCU
OtherSubsystem
Node
Payload
Component

Definition at line 69 of file reportidentification.h.

enum JAUS::ReportIdentification::QueryType

Enumerator:

Reserved
SystemIdentification
SubsystemIdentification
NodeIdentification
ComponentIdentification

Definition at line 59 of file reportidentification.h.

Constructor & Destructor Documentation

ReportIdentification::ReportIdentification	(	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 reportidentification.cpp.

ReportIdentification::ReportIdentification ( const ReportIdentification & message )

Copy constructor.

Definition at line 66 of file reportidentification.cpp.

ReportIdentification::~ReportIdentification ( )

Destructor.

Definition at line 79 of file reportidentification.cpp.

Member Function Documentation

void ReportIdentification::ClearMessageBody ( ) [virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 166 of file reportidentification.cpp.

virtual Message* JAUS::ReportIdentification::Clone ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 90 of file reportidentification.h.

std::string JAUS::ReportIdentification::GetIdentification ( ) const [inline]

Definition at line 86 of file reportidentification.h.

virtual UShort JAUS::ReportIdentification::GetMessageCodeOfResponse ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 94 of file reportidentification.h.

virtual std::string JAUS::ReportIdentification::GetMessageName ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 95 of file reportidentification.h.

virtual UInt JAUS::ReportIdentification::GetPresenceVector ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 91 of file reportidentification.h.

virtual UInt JAUS::ReportIdentification::GetPresenceVectorMask ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 93 of file reportidentification.h.

virtual UInt JAUS::ReportIdentification::GetPresenceVectorSize ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 92 of file reportidentification.h.

QueryType JAUS::ReportIdentification::GetQueryType ( ) const [inline]

Definition at line 84 of file reportidentification.h.

IdentificationType JAUS::ReportIdentification::GetType ( ) const [inline]

Definition at line 85 of file reportidentification.h.

virtual bool JAUS::ReportIdentification::IsCommand ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 87 of file reportidentification.h.

virtual bool JAUS::ReportIdentification::IsLargeDataSet ( const unsigned int maxPayloadSize ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 97 of file reportidentification.h.

ReportIdentification & ReportIdentification::operator= ( const ReportIdentification & message )

Sets equal to.

Definition at line 179 of file reportidentification.cpp.

int ReportIdentification::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 144 of file reportidentification.cpp.

bool ReportIdentification::SetIdentification ( const std::string & identification )

Sets the identification.

Parameters:

[in] identification Identification string in human-recognizable format. Size must be <= 255 characters.

Returns:: True on success, false on failure.

Definition at line 95 of file reportidentification.cpp.

void JAUS::ReportIdentification::SetQueryType ( const QueryType type ) [inline]

Definition at line 81 of file reportidentification.h.

void JAUS::ReportIdentification::SetType ( const IdentificationType type ) [inline]

Definition at line 82 of file reportidentification.h.

int ReportIdentification::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 117 of file reportidentification.cpp.

Member Data Documentation

std::string JAUS::ReportIdentification::mIdentification [protected]

Identification name [up to 255 characters].

Definition at line 102 of file reportidentification.h.

IdentificationType JAUS::ReportIdentification::mIdentificationType [protected]

Type of subsystem, node type, or component type.

Definition at line 101 of file reportidentification.h.

QueryType JAUS::ReportIdentification::mQueryType [protected]

Type of query the report is responding to.

Definition at line 100 of file reportidentification.h.

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

jaus++/2.0/include/jaus/core/discovery/reportidentification.h
jaus++/2.0/src/jaus/core/discovery/reportidentification.cpp

JAUS::ReportIdentification Class Reference

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation