DDS  ver. 3.5.3.8.g5fe284b
Public Types | 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::CTopoContainer dds::topology_api::CTopoTask dds::topology_api::CTopoCollection dds::topology_api::CTopoGroup

Public Types

using Ptr_t = std::shared_ptr< CTopoElement >
 
using PtrVector_t = std::vector< CTopoElement::Ptr_t >
 
- Public Types inherited from dds::topology_api::CTopoBase
enum  EType {
  EType::TOPO_BASE, EType::TOPO_PROPERTY, EType::TOPO_ELEMENT, EType::TASK,
  EType::COLLECTION, EType::GROUP, EType::REQUIREMENT, EType::TOPO_VARS,
  EType::TRIGGER
}
 
using Ptr_t = std::shared_ptr< CTopoBase >
 
using PtrVector_t = std::vector< CTopoBase::Ptr_t >
 

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 setName (const std::string &_name)
 Modifiers. More...
 
void setParent (CTopoBase *_parent)
 
const std::string & getName () const
 Accessors. More...
 
CTopoBase::EType getType () const
 
CTopoBasegetParent () const
 
std::string getPath () const
 Return full path to topo element or property. More...
 
void initFromXML (const std::string &_filepath, const std::string &_schemaFilepath="", std::string *_topologyName=nullptr)
 Initializes object with data from XML file. More...
 
void initFromXML (std::istream &_stream, const std::string &_schemaFilepath="", std::string *_topologyName=nullptr)
 Initializes object with data from XML input stream. More...
 
virtual void initFromPropertyTree (const boost::property_tree::ptree &_pt)=0
 Initialize object with data from property tree. More...
 
virtual void saveToPropertyTree (boost::property_tree::ptree &_pt)=0
 Save object to a property tree. More...
 
virtual std::string toString () const
 Returns string representation of an object. More...
 
virtual std::string hashString () const =0
 Returns string which is used to calculate CRC checksum of the object. More...
 

Protected Member Functions

 CTopoElement (const std::string &_name)
 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 (const std::string &_name)
 Constructor. More...
 
virtual ~CTopoBase ()
 Destructor. More...
 
void setType (CTopoBase::EType _type)
 

Additional Inherited Members

- Static Public Member Functions inherited from dds::topology_api::CTopoBase
template<class Object_t >
static Object_t::Ptr_t make (const std::string &_objectName, const std::string &_filepath, const std::string &_schemaFilepath="", std::string *_topologyName=nullptr)
 Convenience API to create topology object from XML file. More...
 
template<class Object_t >
static Object_t::Ptr_t make (const std::string &_objectName, std::istream &_stream, const std::string &_schemaFilepath="", std::string *_topologyName=nullptr)
 Convenience API to create topology object from XML file. More...
 
template<class Object_t >
static Object_t::Ptr_t make (const std::string &_name, const boost::property_tree::ptree &_pt)
 Convenience API to create topology object with data from property tree. More...
 

Member Typedef Documentation

◆ Ptr_t

◆ PtrVector_t

Constructor & Destructor Documentation

◆ CTopoElement()

CTopoElement::CTopoElement ( const std::string &  _name)
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::CTopoTask, dds::topology_api::CTopoCollection, and dds::topology_api::CTopoGroup.

◆ 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::CTopoTask, dds::topology_api::CTopoCollection, and dds::topology_api::CTopoGroup.


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