DDS  ver. 2.0
Public Member Functions | Protected Member Functions | Friends | List of all members
dds::topology_api::CTaskContainer Class Reference

#include <TaskContainer.h>

Inheritance diagram for dds::topology_api::CTaskContainer:
dds::topology_api::CTopoElement dds::topology_api::CTopoBase dds::topology_api::CTaskCollection dds::topology_api::CTaskGroup

Public Member Functions

size_t getNofElements () const
 Return number of elements. More...
 
TopoElementPtr_t getElement (size_t _i) const
 Return topology element by index. More...
 
const TopoElementPtrVector_tgetElements () const
 Return vector of elements. More...
 
void setElements (const TopoElementPtrVector_t &_elements)
 
void addElement (TopoElementPtr_t _element)
 
virtual std::string toString () const
 Returns string representation of an object. More...
 
- Public Member Functions inherited from dds::topology_api::CTopoElement
virtual size_t getNofTasks () const =0
 Return number of all tasks including daughter elements. More...
 
virtual size_t getTotalNofTasks () const =0
 Return total number of tasks, i.e. number of tasks multiplied by n. More...
 
- Public Member Functions inherited from dds::topology_api::CTopoBase
void setId (const std::string &_id)
 Modifiers. More...
 
void setParent (CTopoBase *_parent)
 
std::string getId () const
 Accessors. More...
 
ETopoType getType () const
 
CTopoBasegetParent () const
 
std::string getPath () const
 Return full path to topo element or property. More...
 
CTopoIndex getIndex () const
 Return index of topo element or property. More...
 
virtual void initFromPropertyTree (const std::string &_name, const boost::property_tree::ptree &_pt)=0
 Initialize object with data from property tree. More...
 

Protected Member Functions

 CTaskContainer ()
 Constructor. More...
 
virtual ~CTaskContainer ()
 Destructor. More...
 
size_t getNofTasksDefault () const
 Default implementation for TopoElement::getNofTasks, TopoElement::getTotalNofTasks. Calculate recursively number of tasks in all daughter elements. More...
 
- Protected Member Functions inherited from dds::topology_api::CTopoElement
 CTopoElement ()
 Constructor. More...
 
virtual ~CTopoElement ()
 Destructor. More...
 
size_t getTotalCounterDefault () const
 If parent is a group than return N, else return 1. Default implementation for Task::getTotalCounter and TaskCollection::getTotalCounter. More...
 
- Protected Member Functions inherited from dds::topology_api::CTopoBase
 CTopoBase ()
 Constructor. More...
 
virtual ~CTopoBase ()
 Destructor. More...
 
void setType (ETopoType _type)
 

Friends

std::ostream & operator<< (std::ostream &_strm, const CTaskContainer &_taskContainer)
 Operator << for convenient output to ostream. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from dds::topology_api::CTopoBase
static const boost::property_tree::ptree & findElement (ETopoType _type, const std::string &_name, const boost::property_tree::ptree &_pt)
 Helper function to find element in property tree by type and name. More...
 

Constructor & Destructor Documentation

◆ CTaskContainer()

CTaskContainer::CTaskContainer ( )
protected

Constructor.

◆ ~CTaskContainer()

CTaskContainer::~CTaskContainer ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ addElement()

void CTaskContainer::addElement ( TopoElementPtr_t  _element)

◆ getElement()

TopoElementPtr_t CTaskContainer::getElement ( size_t  _i) const

Return topology element by index.

Returns
Topology element by index.
Exceptions
std::out_of_range

◆ getElements()

const TopoElementPtrVector_t & CTaskContainer::getElements ( ) const

Return vector of elements.

Returns
Vector of elements.

◆ getNofElements()

size_t CTaskContainer::getNofElements ( ) const

Return number of elements.

Returns
Number of elements.

◆ getNofTasksDefault()

size_t CTaskContainer::getNofTasksDefault ( ) const
protected

Default implementation for TopoElement::getNofTasks, TopoElement::getTotalNofTasks. Calculate recursively number of tasks in all daughter elements.

◆ setElements()

void CTaskContainer::setElements ( const TopoElementPtrVector_t _elements)

◆ toString()

string CTaskContainer::toString ( ) const
virtual

Returns string representation of an object.

Returns
String representation of an object.

Reimplemented from dds::topology_api::CTopoBase.

Reimplemented in dds::topology_api::CTaskGroup.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  _strm,
const CTaskContainer _taskContainer 
)
friend

Operator << for convenient output to ostream.

Returns
Insertion stream in order to be able to call a succession of insertion operations.

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