Public Types | Public Member Functions | Public Attributes

JAUS::Element Class Reference

This class encapsulates a Jaus AS6009 Element used in the List Manager Service. More...

#include <element.h>

List of all members.

Public Types

typedef std::map< UShort, ElementMap
 Type definition for STL map of Elements.
typedef std::vector< ElementList
 List of elements.

Public Member Functions

 Element (const UShort id=0, const UShort next=0, const UShort prev=0)
 Constructor, initializes values.
 Element (const Element &element)
 Copy constructor.
 ~Element ()
 Destructor.
void Clear ()
 Clears the element.
Elementoperator= (const Element &element)
 Sets equal to (copies data).

Public Attributes

UShort mID
 ID of the element.
UShort mNextID
 ID of the next element in a list.
UShort mPrevID
 ID of the previous element in a list.
MessagempElement
 Pointer to actual element data (Message Payload).
Packet mPayload
 Payload data (serialized message data).

Detailed Description

This class encapsulates a Jaus AS6009 Element used in the List Manager Service.

Definition at line 58 of file element.h.


Member Typedef Documentation

typedef std::vector<Element> JAUS::Element::List

List of elements.

Definition at line 62 of file element.h.

typedef std::map<UShort, Element> JAUS::Element::Map

Type definition for STL map of Elements.

Definition at line 61 of file element.h.


Constructor & Destructor Documentation

Element::Element ( const UShort  id = 0,
const UShort  next = 0,
const UShort  prev = 0 
)

Constructor, initializes values.

Parameters:
[in]idThe element UID.
[in]nextThe next element in the list ID. 0 if this is a tail element.
[in]prevThe previous element in the list ID. 0 if this is a root element.

Definition at line 56 of file element.cpp.

Element::Element ( const Element element )

Copy constructor.

Definition at line 71 of file element.cpp.

Element::~Element (  )

Destructor.

Definition at line 85 of file element.cpp.


Member Function Documentation

void Element::Clear (  )

Clears the element.

Definition at line 100 of file element.cpp.

Element & Element::operator= ( const Element element )

Sets equal to (copies data).

Definition at line 119 of file element.cpp.


Member Data Documentation

ID of the element.

Definition at line 70 of file element.h.

ID of the next element in a list.

Definition at line 71 of file element.h.

Payload data (serialized message data).

Definition at line 74 of file element.h.

Pointer to actual element data (Message Payload).

Definition at line 73 of file element.h.

ID of the previous element in a list.

Definition at line 72 of file element.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines