DDS  ver. 2.0
Public Member Functions | Protected Member Functions | List of all members
dds::topology_api::CTopoElement Class Referenceabstract

#include <TopoElement.h>

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

Public Member Functions

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...
 
virtual std::string toString () const
 Returns string representation of an object. More...
 

Protected Member Functions

 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)
 

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

◆ CTopoElement()

CTopoElement::CTopoElement ( )
protected

Constructor.

◆ ~CTopoElement()

CTopoElement::~CTopoElement ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ getNofTasks()

virtual size_t dds::topology_api::CTopoElement::getNofTasks ( ) const
pure virtual

Return number of all tasks including daughter elements.

Implemented in dds::topology_api::CTask, dds::topology_api::CTaskCollection, and dds::topology_api::CTaskGroup.

◆ getTotalCounterDefault()

size_t CTopoElement::getTotalCounterDefault ( ) const
protected

If parent is a group than return N, else return 1. Default implementation for Task::getTotalCounter and TaskCollection::getTotalCounter.

◆ getTotalNofTasks()

virtual size_t dds::topology_api::CTopoElement::getTotalNofTasks ( ) const
pure virtual

Return total number of tasks, i.e. number of tasks multiplied by n.

Implemented in dds::topology_api::CTask, dds::topology_api::CTaskCollection, and dds::topology_api::CTaskGroup.


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