torc::generic::StatusContainer Class Reference

Represents objects that have status. More...

#include <StatusContainer.hpp>

Inheritance diagram for torc::generic::StatusContainer:

Public Member Functions
void	getStatuses (std::vector< StatusSharedPtr > &outStatus) const
void	setStatuses (const std::vector< StatusSharedPtr > &inStatus)
void	addStatus (const StatusSharedPtr &inStatus) throw (Error)
template<typename _Action >
void	applyOnAllStatuses (const _Action &action) throw (Error)
	~StatusContainer () throw ()

Protected Member Functions
	StatusContainer ()

Private Member Functions
	StatusContainer (const StatusContainer &source)
StatusContainer &	operator= (const StatusContainer &source)

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 35 of file StatusContainer.hpp.

Constructor & Destructor Documentation

torc::generic::StatusContainer::~StatusContainer	(		)
throw	(
	)

Definition at line 25 of file StatusContainer.cpp.

{}

torc::generic::StatusContainer::StatusContainer ( )

protected

Definition at line 22 of file StatusContainer.cpp.

                                 :
    mStatuses() {}

torc::generic::StatusContainer::StatusContainer ( const StatusContainer &  source )

private

Member Function Documentation

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 47 of file StatusContainer.cpp.

                                                                             {
    mStatuses.push_back(inStatus);
}

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 95 of file StatusContainer.hpp.

                  {
    try {
        std::vector<StatusSharedPtr>::iterator it = mStatuses.begin();
        for(; it != mStatuses.end(); ++it) {
            action(*it);
        }
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

void torc::generic::StatusContainer::getStatuses ( std::vector< StatusSharedPtr > &  outStatus ) const

inline

Get a vector of pointer to Status object

Parameters

[out]

outStatus

The vector of pointer to Status object

Definition at line 86 of file StatusContainer.hpp.

                                                                                    {
    outStatus.insert(outStatus.end(), mStatuses.begin(), mStatuses.end());
}

StatusContainer& torc::generic::StatusContainer::operator= ( const StatusContainer &  source )

private

void torc::generic::StatusContainer::setStatuses

(

const std::vector< StatusSharedPtr > &

inStatus

)

Set a vector of pointer to Status object

Parameters

[in]

inStatus

The vector of pointer to Status object

Definition at line 32 of file StatusContainer.cpp.

                                                                            {
    std::vector<StatusSharedPtr>::const_iterator it = inStatus.begin();
    for(; it != inStatus.end(); it++) {
        mStatuses.push_back(*it);
    }
}

Field Documentation

std::vector<StatusSharedPtr> torc::generic::StatusContainer::mStatuses

private

Definition at line 78 of file StatusContainer.hpp.

---

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

• StatusContainer.hpp
• StatusContainer.cpp