torc::generic::StatusContainer Class Reference

Represents objects that have status. More...

#include <StatusContainer.hpp>

Inheritance diagram for torc::generic::StatusContainer:

[legend]

List of all members.

Public Member Functions
void	getStatuses (std::vector< StatusSharedPtr > &outStatus) const throw ()
void	setStatuses (const std::vector< StatusSharedPtr > &inStatus) throw ()
void	addStatus (const StatusSharedPtr &inStatus) throw (Error)
template<typename _Action>
void	applyOnAllStatuses (const _Action &action) throw (Error)
Private Member Functions
	StatusContainer (const StatusContainer &source) throw ()
StatusContainer &	operator= (const StatusContainer &source) throw ()
Private Attributes
std::vector< StatusSharedPtr >	mStatuses

---

Detailed Description

Represents objects that have status.

The StatusContainer interface is generalized by classes that need to hold status.

Definition at line 36 of file StatusContainer.hpp.

---

Member Function Documentation

void torc::generic::StatusContainer::getStatuses

(

std::vector< StatusSharedPtr > &

outStatus

)

const throw () [inline]

Get a vector of pointer to Status object

Parameters:

[out]

outStatus

The vector of pointer to Status object

Definition at line 94 of file StatusContainer.hpp.

void torc::generic::StatusContainer::setStatuses

(

const std::vector< StatusSharedPtr > &

inStatus

)

throw ()

Set a vector of pointer to Status object

Parameters:

[in]

inStatus

The vector of pointer to Status object

Definition at line 36 of file StatusContainer.cpp.

void torc::generic::StatusContainer::addStatus

(

const StatusSharedPtr &

inStatus

)

throw (Error)

Add a status to the vector of statuses. If an empty pointer is supplied, it returns without doing anything.

Parameters:

[in]

inStatus

A pointer to a status object.

Exceptions:

Error

Status could not be added.

Add a status to the list of statuses. If an empty pointer is supplied, it returns without doing anything.

Parameters:

[in]

inStatus

A pointer to a status object.

Exceptions:

Error

Status could not be added.

Definition at line 52 of file StatusContainer.cpp.

template<typename _Action>

void torc::generic::StatusContainer::applyOnAllStatuses

(

const _Action &

action

)

throw (Error) [inline]

Apply action on all statuses.

Parameters:

[in]

action

Action to be applied

Definition at line 106 of file StatusContainer.hpp.

---

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

• torc/generic/om/StatusContainer.hpp
• torc/generic/om/StatusContainer.cpp