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

Data class to hold task trigger. More...

#include <Trigger.h>

Inheritance diagram for dds::topology_api::CTrigger:
dds::topology_api::CTopoBase

Public Member Functions

 CTrigger ()
 Constructor. More...
 
virtual ~CTrigger ()
 Destructor. More...
 
void initFromPropertyTree (const std::string &_name, const 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...
 
- 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...
 

Friends

std::ostream & operator<< (std::ostream &_strm, const CTrigger &_trigger)
 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...
 
- Protected Member Functions inherited from dds::topology_api::CTopoBase
 CTopoBase ()
 Constructor. More...
 
virtual ~CTopoBase ()
 Destructor. More...
 
void setType (ETopoType _type)
 

Detailed Description

Data class to hold task trigger.

Constructor & Destructor Documentation

◆ CTrigger()

CTrigger::CTrigger ( )

Constructor.

◆ ~CTrigger()

CTrigger::~CTrigger ( )
virtual

Destructor.

Member Function Documentation

◆ getAction()

EActionType CTrigger::getAction ( ) const

◆ getArgument()

const std::string & CTrigger::getArgument ( ) const

◆ getCondition()

EConditionType CTrigger::getCondition ( ) const

◆ initFromPropertyTree()

void CTrigger::initFromPropertyTree ( const std::string &  _name,
const boost::property_tree::ptree &  _pt 
)
virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

◆ setAction()

void CTrigger::setAction ( EActionType  _action)

◆ setArgument()

void CTrigger::setArgument ( const std::string &  _argument)

◆ setCondition()

void CTrigger::setCondition ( EConditionType  _condition)

◆ toString()

string CTrigger::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 CTrigger _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: