#include <TopoTask.h>

Inheritance diagram for dds::topology_api::CTopoTask:

Public Types
using	Ptr_t = std::shared_ptr< CTopoTask >

using	PtrVector_t = std::vector< CTopoTask::Ptr_t >

Public Types inherited from dds::topology_api::CTopoElement
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
	CTopoTask (const std::string &_name)
	Constructor. More...

virtual	~CTopoTask ()
	Destructor. More...

const std::string &	getExe () const
	Accessors. More...

const std::string &	getEnv () const

bool	isExeReachable () const

bool	isEnvReachable () const

size_t	getNofProperties () const

size_t	getNofRequirements () const

size_t	getNofTriggers () const

const CTopoProperty::PtrMap_t &	getProperties () const

const CTopoRequirement::PtrVector_t &	getRequirements () const

const CTopoTrigger::PtrVector_t &	getTriggers () const

CTopoProperty::Ptr_t	getProperty (const std::string &_id) const
	Get property by ID. If property not fount than return nullptr. More...

void	setExe (const std::string &_exe)
	Modifiers. More...

void	setEnv (const std::string &_env)

void	setExeReachable (bool _exeReachable)

void	setEnvReachable (bool _envReachable)

CTopoProperty::Ptr_t	addProperty (const std::string &_name)

CTopoRequirement::Ptr_t	addRequirement (const std::string &_name)

CTopoTrigger::Ptr_t	addTrigger (const std::string &_name)

std::string	getParentCollectionId () const

std::string	getParentGroupId () const

size_t	getTotalCounter () const
	If parent is a group than return N, else return 1. More...

virtual size_t	getNofTasks () const
	Inherited from DDSTopoElement. More...

virtual size_t	getTotalNofTasks () const
	Inherited from DDSTopoElement. More...

virtual void	initFromPropertyTree (const boost::property_tree::ptree &_pt)
	Inherited from TopoElement. More...

virtual void	saveToPropertyTree (boost::property_tree::ptree &_pt)
	Inherited from TopoElement. More...

virtual std::string	toString () const
	Returns string representation of an object. More...

virtual std::string	hashString () const
	Inherited from TopoBase. 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

CTopoBase *	getParent () 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...

Friends
std::ostream &	operator<< (std::ostream &_strm, const CTopoTask &_task)
	Operator << for convenient output to ostream. More...

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 &_name, const boost::property_tree::ptree &_pt)
	Convenience API to create topology object with data from property tree. More...

Protected Member Functions inherited from dds::topology_api::CTopoElement
	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)

Member Typedef Documentation

◆ Ptr_t

using dds::topology_api::CTopoTask::Ptr_t = std::shared_ptr<CTopoTask>

◆ PtrVector_t

using dds::topology_api::CTopoTask::PtrVector_t = std::vector<CTopoTask::Ptr_t>

Constructor & Destructor Documentation

◆ CTopoTask()

CTopoTask::CTopoTask ( const std::string & _name )

Constructor.

◆ ~CTopoTask()

CTopoTask::~CTopoTask ( )

virtual

Destructor.

Member Function Documentation

◆ addProperty()

CTopoProperty::Ptr_t CTopoTask::addProperty ( const std::string & _name )

◆ addRequirement()

CTopoRequirement::Ptr_t CTopoTask::addRequirement ( const std::string & _name )

◆ addTrigger()

CTopoTrigger::Ptr_t CTopoTask::addTrigger ( const std::string & _name )

◆ getEnv()

const string & CTopoTask::getEnv ( ) const

◆ getExe()

const string & CTopoTask::getExe ( ) const

Accessors.

◆ getNofProperties()

size_t CTopoTask::getNofProperties ( ) const

◆ getNofRequirements()

size_t CTopoTask::getNofRequirements ( ) const

◆ getNofTasks()

size_t CTopoTask::getNofTasks ( ) const

virtual

Inherited from DDSTopoElement.

Implements dds::topology_api::CTopoElement.

◆ getNofTriggers()

size_t CTopoTask::getNofTriggers ( ) const

◆ getParentCollectionId()

std::string CTopoTask::getParentCollectionId ( ) const

◆ getParentGroupId()

std::string CTopoTask::getParentGroupId ( ) const

◆ getProperties()

const CTopoProperty::PtrMap_t & CTopoTask::getProperties ( ) const

◆ getProperty()

CTopoProperty::Ptr_t CTopoTask::getProperty ( const std::string & _id ) const

Get property by ID. If property not fount than return nullptr.

◆ getRequirements()

const CTopoRequirement::PtrVector_t & CTopoTask::getRequirements ( ) const

◆ getTotalCounter()

size_t CTopoTask::getTotalCounter ( ) const

If parent is a group than return N, else return 1.

◆ getTotalNofTasks()

size_t CTopoTask::getTotalNofTasks ( ) const

virtual

Inherited from DDSTopoElement.

Implements dds::topology_api::CTopoElement.

◆ getTriggers()

const CTopoTrigger::PtrVector_t & CTopoTask::getTriggers ( ) const

◆ hashString()

string CTopoTask::hashString ( ) const

virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

◆ initFromPropertyTree()

void CTopoTask::initFromPropertyTree ( const boost::property_tree::ptree & _pt )

virtual

Inherited from TopoElement.

Implements dds::topology_api::CTopoBase.

◆ isEnvReachable()

bool CTopoTask::isEnvReachable ( ) const

◆ isExeReachable()

bool CTopoTask::isExeReachable ( ) const

◆ saveToPropertyTree()

void CTopoTask::saveToPropertyTree ( boost::property_tree::ptree & _pt )

virtual

Inherited from TopoElement.

Implements dds::topology_api::CTopoBase.

◆ setEnv()

void CTopoTask::setEnv ( const std::string & _env )

◆ setEnvReachable()

void CTopoTask::setEnvReachable ( bool _envReachable )

◆ setExe()

void CTopoTask::setExe ( const std::string & _exe )

Modifiers.

◆ setExeReachable()

void CTopoTask::setExeReachable ( bool _exeReachable )

◆ toString()

string CTopoTask::toString ( ) const

virtual

Returns string representation of an object.

Returns: String representation of an object.

Reimplemented from dds::topology_api::CTopoBase.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	_strm,
		const CTopoTask &	_task
	)

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:

Public Types

Public Member Functions

Friends

Additional Inherited Members

Member Typedef Documentation

◆ Ptr_t

◆ PtrVector_t

Constructor & Destructor Documentation

◆ CTopoTask()

◆ ~CTopoTask()

Member Function Documentation

◆ addProperty()

◆ addRequirement()

◆ addTrigger()

◆ getEnv()

◆ getExe()

◆ getNofProperties()

◆ getNofRequirements()

◆ getNofTasks()

◆ getNofTriggers()

◆ getParentCollectionId()

◆ getParentGroupId()

◆ getProperties()

◆ getProperty()

◆ getRequirements()

◆ getTotalCounter()

◆ getTotalNofTasks()

◆ getTriggers()

◆ hashString()

◆ initFromPropertyTree()

◆ isEnvReachable()

◆ isExeReachable()

◆ saveToPropertyTree()

◆ setEnv()

◆ setEnvReachable()

◆ setExe()

◆ setExeReachable()

◆ toString()

Friends And Related Function Documentation

◆ operator<<