RTT::scripting::EdgeCondition Class Reference

This class represents a conditional branch in a program tree. More...

#include <rtt/scripting/EdgeCondition.hpp>

Public Types
typedef property< edge_condition_t, EdgeCondition, property< boost::edge_index_t, int > >	EdgeProperty

Public Member Functions
	EdgeCondition ()
	Create a default EdgeCondition which evaluates always as true. More...
	EdgeCondition (ConditionInterface *cond)
	EdgeCondition specifies a condition to check. More...
	~EdgeCondition ()
	EdgeCondition (const EdgeCondition &orig)
EdgeCondition &	operator= (const EdgeCondition &orig)
EdgeCondition	copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &replacementdss) const
void	reset ()
	Reset the condition in this EdgeCondition. More...
bool	evaluate ()
	Evaluates the condition coupled with this termination clause. More...
ConditionInterface *	getCondition () const
	Return the condition coupled with this termination clause. More...
int	getRank () const

Protected Member Functions
void	setCondition (ConditionInterface *cond)

Detailed Description

This class represents a conditional branch in a program tree.

It contains a condition which must be satisfied to pass to the next node.

Definition at line 72 of file EdgeCondition.hpp.

Member Typedef Documentation

typedef property<edge_condition_t, EdgeCondition, property< boost::edge_index_t, int> > RTT::scripting::EdgeCondition::EdgeProperty

Definition at line 77 of file EdgeCondition.hpp.

Constructor & Destructor Documentation

RTT::EdgeCondition::EdgeCondition

(

)

Create a default EdgeCondition which evaluates always as true.

Definition at line 48 of file EdgeCondition.cpp.

RTT::EdgeCondition::EdgeCondition

(

ConditionInterface *

cond

)

EdgeCondition specifies a condition to check.

This EdgeCondition takes ownership of cond.

Definition at line 51 of file EdgeCondition.cpp.

RTT::EdgeCondition::~EdgeCondition

(

)

Definition at line 56 of file EdgeCondition.cpp.

RTT::EdgeCondition::EdgeCondition

(

const EdgeCondition &

orig

)

Definition at line 82 of file EdgeCondition.cpp.

Member Function Documentation

EdgeCondition RTT::EdgeCondition::copy

(

std::map< const base::DataSourceBase *, base::DataSourceBase * > &

replacementdss

)

const

Definition at line 87 of file EdgeCondition.cpp.

References getCondition(), and setCondition().

bool RTT::EdgeCondition::evaluate

(

)

Evaluates the condition coupled with this termination clause.

Definition at line 67 of file EdgeCondition.cpp.

References RTT::scripting::ConditionInterface::evaluate().

ConditionInterface * RTT::EdgeCondition::getCondition

(

)

const

Return the condition coupled with this termination clause.

Definition at line 72 of file EdgeCondition.cpp.

Referenced by copy(), and operator=().

int RTT::scripting::EdgeCondition::getRank ( ) const

inline

Definition at line 117 of file EdgeCondition.hpp.

Referenced by operator=().

EdgeCondition & RTT::EdgeCondition::operator=

(

const EdgeCondition &

orig

)

Definition at line 94 of file EdgeCondition.cpp.

References RTT::scripting::ConditionInterface::clone(), getCondition(), and getRank().

void RTT::EdgeCondition::reset

(

)

Reset the condition in this EdgeCondition.

See the documentation of ConditionInterface::reset() for more details..

Definition at line 77 of file EdgeCondition.cpp.

References RTT::scripting::ConditionInterface::reset().

void RTT::EdgeCondition::setCondition ( ConditionInterface *  cond )

protected

Definition at line 61 of file EdgeCondition.cpp.

Referenced by copy().

---

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

• rtt/scripting/EdgeCondition.hpp
• rtt/scripting/EdgeCondition.cpp