Ocean::Maintenance::Element Class Reference

This class implements a maintenance data element. More...

#include <Maintenance.h>

Public Member Functions
	Element ()
	Creates a new empty element.
	Element (const Element &element)
	Copy constructor.
	Element (Element &&element)
	Move constructor.
	Element (const std::string &name, const unsigned long long id, const Timestamp timestamp, const std::string &tag, const Buffer &buffer)
	Creates a new maintenance element.
	Element (const std::string &name, const unsigned long long id, const Timestamp timestamp, const std::string &tag, Buffer &&buffer)
	Creates a new maintenance element.
const std::string &	name () const
	Returns the name of the maintenance manager to which the maintenance of this element data has been sent.
std::string &	name ()
	Returns the name of the maintenance manager to which the maintenance of this element data has been sent.
unsigned long long	id () const
	Return sthe id of the maintenance manager to which the maintenance data of this element has been sent.
Timestamp	timestamp () const
	The timestamp of the maintenance data of this element.
const std::string &	tag () const
	Returns the tag of the maintenance data of this element.
std::string &	tag ()
	Returns the tag of the maintenance data of this element.
const Buffer &	buffer () const
	Returns the buffer of the maintenance data of this element.
Buffer &	buffer ()
	Returns the buffer of the maintenance data of this element.
Element &	operator= (const Element &element)
	Assign operator.
Element &	operator= (Element &&element)
	Assign operator.

Protected Attributes
std::string	elementName
	The name of the manager to which the data has been sent.
unsigned long long	elementId
	The id of the manager to which the data has been sent.
Timestamp	elementTimestamp
	The timestamp of the data.
std::string	elementTag
	The tag of the data.
Buffer	elementBuffer
	The buffer of the data.

Detailed Description

This class implements a maintenance data element.

Constructor & Destructor Documentation

Element() [1/5]

Ocean::Maintenance::Element::Element ( )

inline

Creates a new empty element.

Element() [2/5]

Ocean::Maintenance::Element::Element ( const Element &  element )

inline

Copy constructor.

Parameters

element

The element to be copied

Element() [3/5]

Ocean::Maintenance::Element::Element ( Element &&  element )

inline

Move constructor.

Parameters

element

The element to be moved

Element() [4/5]

Ocean::Maintenance::Element::Element ( const std::string &  name, const unsigned long long  id, const Timestamp  timestamp, const std::string &  tag, const Buffer &  buffer  )

inline

Creates a new maintenance element.

Parameters

name	The name of the maintenance manager to which the data has been sent
id	The id of the maintenance manager to which the data has been set
timestamp	The timestamp of the maintenance data
tag	The tag of the maintenance data
buffer	The maintenance data as buffer

Element() [5/5]

Ocean::Maintenance::Element::Element ( const std::string &  name, const unsigned long long  id, const Timestamp  timestamp, const std::string &  tag, Buffer &&  buffer  )

inline

Creates a new maintenance element.

Parameters

name	The name of the maintenance manager to which the data has been sent
id	The id of the maintenance manager to which the data has been set
timestamp	The timestamp of the maintenance data
tag	The tag of the maintenance data
buffer	The maintenance data as buffer, will be moved

Member Function Documentation

buffer() [1/2]

Maintenance::Buffer & Ocean::Maintenance::Element::buffer ( )

inline

Returns the buffer of the maintenance data of this element.

Returns

The buffer of the maintenance data

buffer() [2/2]

const Maintenance::Buffer & Ocean::Maintenance::Element::buffer ( ) const

inline

Returns the buffer of the maintenance data of this element.

Returns

The buffer of the maintenance data

id()

unsigned long long Ocean::Maintenance::Element::id ( ) const

inline

Return sthe id of the maintenance manager to which the maintenance data of this element has been sent.

Returns

The id of the maintenance manager

name() [1/2]

std::string & Ocean::Maintenance::Element::name ( )

inline

Returns the name of the maintenance manager to which the maintenance of this element data has been sent.

Returns

The readable name of the maintenance manager

name() [2/2]

const std::string & Ocean::Maintenance::Element::name ( ) const

inline

Returns the name of the maintenance manager to which the maintenance of this element data has been sent.

Returns

The readable name of the maintenance manager

operator=() [1/2]

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

inline

Assign operator.

Parameters

element

The second element to be copied

Returns

Reference to this element

operator=() [2/2]

Maintenance::Element & Ocean::Maintenance::Element::operator= ( Element &&  element )

inline

Assign operator.

Parameters

element

The second element to be moved

Returns

Reference to this element

tag() [1/2]

std::string & Ocean::Maintenance::Element::tag ( )

inline

Returns the tag of the maintenance data of this element.

Returns

The tag of the maintenance data

tag() [2/2]

const std::string & Ocean::Maintenance::Element::tag ( ) const

inline

Returns the tag of the maintenance data of this element.

Returns

The tag of the maintenance data

timestamp()

Timestamp Ocean::Maintenance::Element::timestamp ( ) const

inline

The timestamp of the maintenance data of this element.

Returns

The timestamp of the maintenance data

Field Documentation

elementBuffer

Buffer Ocean::Maintenance::Element::elementBuffer

protected

The buffer of the data.

elementId

unsigned long long Ocean::Maintenance::Element::elementId

protected

The id of the manager to which the data has been sent.

elementName

std::string Ocean::Maintenance::Element::elementName

protected

The name of the manager to which the data has been sent.

elementTag

std::string Ocean::Maintenance::Element::elementTag

protected

The tag of the data.

elementTimestamp

Timestamp Ocean::Maintenance::Element::elementTimestamp

protected

The timestamp of the data.

---

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

• Maintenance.h