dds::topology_api::CTopoTrigger Class Reference

#include <TopoTrigger.h>

Inheritance diagram for dds::topology_api::CTopoTrigger:

Public Types
enum	EConditionType { EConditionType::None, EConditionType::TaskCrashed }
enum	EActionType { EActionType::None, EActionType::RestartTask }
using	Ptr_t = std::shared_ptr< CTopoTrigger >
using	PtrVector_t = std::vector< CTopoTrigger::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
	CTopoTrigger (const std::string &_name)
	Constructor. More...
virtual	~CTopoTrigger ()
	Destructor. More...
void	initFromPropertyTree (const boost::property_tree::ptree &_pt)
	Inherited from TopoBase. More...
void	saveToPropertyTree (boost::property_tree::ptree &_pt)
	Inherited from TopoBase. More...
EConditionType	getCondition () const
EActionType	getAction () const
const std::string &	getArgument () const
void	setAction (EActionType _action)
void	setCondition (EConditionType _condition)
void	setArgument (const std::string &_argument)
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...
void	initFromXML (std::istream &_stream, const std::string &_schemaFilepath="", std::string *_topologyName=nullptr)
	Initializes object with data from XML input stream. More...

Friends
std::ostream &	operator<< (std::ostream &_strm, const CTopoTrigger &_trigger)
	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 &_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...
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::CTopoTrigger::Ptr_t = std::shared_ptr<CTopoTrigger>

PtrVector_t

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

Member Enumeration Documentation

EActionType

enum dds::topology_api::CTopoTrigger::EActionType

strong

Enumerator
None
RestartTask

EConditionType

enum dds::topology_api::CTopoTrigger::EConditionType

strong

Enumerator
None
TaskCrashed

Constructor & Destructor Documentation

CTopoTrigger()

CTopoTrigger::CTopoTrigger

(

const std::string &

_name

)

Constructor.

~CTopoTrigger()

CTopoTrigger::~CTopoTrigger ( )

virtual

Destructor.

Member Function Documentation

getAction()

CTopoTrigger::EActionType CTopoTrigger::getAction

(

)

const

getArgument()

const std::string & CTopoTrigger::getArgument

(

)

const

getCondition()

CTopoTrigger::EConditionType CTopoTrigger::getCondition

(

)

const

hashString()

string CTopoTrigger::hashString ( ) const

virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

initFromPropertyTree()

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

virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

saveToPropertyTree()

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

virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

setAction()

void CTopoTrigger::setAction

(

CTopoTrigger::EActionType

_action

)

setArgument()

void CTopoTrigger::setArgument

(

const std::string &

_argument

)

setCondition()

void CTopoTrigger::setCondition

(

CTopoTrigger::EConditionType

_condition

)

toString()

string CTopoTrigger::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 CTopoTrigger &  _trigger  )

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:

• TopoTrigger.h
• TopoTrigger.cpp