JAUS::ReportElement Class Reference

This message is used to report a single element from a list. The element is uniquely identified by the UID, while it's position within the list is denoted by the previous (parent) and next (child) elements. More...

#include <reportelement.h>

Inheritance diagram for JAUS::ReportElement:

List of all members.

Public Member Functions
	ReportElement (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	ReportElement (const ReportElement &message)
	Copy constructor.
	~ReportElement ()
	Destructor.
bool	SetElement (const Element &element)
	Sets the element to report.
Element	GetElement () 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 contents.
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize=1437) const
	Checks to see if the message will be part of a large data set.
virtual int	RunTestCase () const
	Runs a test case to validate the message class.
ReportElement &	operator= (const ReportElement &message)
	Sets equal to.
Protected Attributes
Element	mElement
	The element to be reported.

---

Detailed Description

This message is used to report a single element from a list. The element is uniquely identified by the UID, while it's position within the list is denoted by the previous (parent) and next (child) elements.

Definition at line 58 of file reportelement.h.

---

Constructor & Destructor Documentation

ReportElement::ReportElement	(	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 reportelement.cpp.

ReportElement::ReportElement

(

const ReportElement &

message )

Copy constructor.

Definition at line 63 of file reportelement.cpp.

ReportElement::~ReportElement

(

)

Destructor.

Definition at line 75 of file reportelement.cpp.

---

Member Function Documentation

void ReportElement::ClearMessageBody

(

)

[virtual]

Clears message contents.

Implements JAUS::Message.

Definition at line 165 of file reportelement.cpp.

virtual Message* JAUS::ReportElement::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file reportelement.h.

Element JAUS::ReportElement::GetElement

(

)

const [inline]

Definition at line 65 of file reportelement.h.

virtual UShort JAUS::ReportElement::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 73 of file reportelement.h.

virtual std::string JAUS::ReportElement::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 74 of file reportelement.h.

virtual UInt JAUS::ReportElement::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 70 of file reportelement.h.

virtual UInt JAUS::ReportElement::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 72 of file reportelement.h.

virtual UInt JAUS::ReportElement::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 71 of file reportelement.h.

virtual bool JAUS::ReportElement::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 66 of file reportelement.h.

bool ReportElement::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [virtual]

Checks to see if the message will be part of a large data set.

Implements JAUS::Message.

Definition at line 176 of file reportelement.cpp.

ReportElement & ReportElement::operator=

(

const ReportElement &

message )

Sets equal to.

Definition at line 248 of file reportelement.cpp.

int ReportElement::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 142 of file reportelement.cpp.

int ReportElement::RunTestCase

(

)

const [virtual]

Runs a test case to validate the message class.

Returns:

1 on success, otherwise 0.

Reimplemented from JAUS::Message.

Definition at line 200 of file reportelement.cpp.

bool ReportElement::SetElement

(

const Element &

element )

Sets the element to report.

Parameters:

[in]

element

The element to report.

Returns:

True on success, false otherwise.

Definition at line 89 of file reportelement.cpp.

int ReportElement::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 107 of file reportelement.cpp.

---

Member Data Documentation

Element JAUS::ReportElement::mElement [protected]

The element to be reported.

Definition at line 80 of file reportelement.h.

---

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

• jaus++/2.0/include/jaus/mobility/list/reportelement.h
• jaus++/2.0/src/jaus/mobility/list/reportelement.cpp