RTT::scripting::ConditionFunction Class Reference

A functor with the ConditionInterface, for the case where the functor is a bool(void). More...

#include <rtt/scripting/CommandFunctors.hpp>

Inheritance diagram for RTT::scripting::ConditionFunction:

Public Types
typedef boost::function< bool(void)>	Function

Public Member Functions
	ConditionFunction (Function impl, bool invert=false)
virtual bool	evaluate ()
	Evaluate the Condition and return the outcome. More...
virtual ConditionFunction *	clone () const
	The Clone Software Pattern. More...
virtual void	reset ()
	Some conditions need to be reset at some points. More...
virtual ConditionInterface *	copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
	When copying an Orocos program, we want identical internal::DataSource's to be mapped to identical DataSources, in order for the program to work correctly. More...

Public Attributes
Function	con
bool	minvert

Detailed Description

A functor with the ConditionInterface, for the case where the functor is a bool(void).

Definition at line 87 of file CommandFunctors.hpp.

Member Typedef Documentation

typedef boost::function<bool(void)> RTT::scripting::ConditionFunction::Function

Definition at line 91 of file CommandFunctors.hpp.

Constructor & Destructor Documentation

RTT::scripting::ConditionFunction::ConditionFunction ( Function  impl, bool  invert = false  )

inline

Definition at line 99 of file CommandFunctors.hpp.

Member Function Documentation

virtual ConditionFunction* RTT::scripting::ConditionFunction::clone ( ) const

inlinevirtual

The Clone Software Pattern.

Implements RTT::scripting::ConditionInterface.

Definition at line 106 of file CommandFunctors.hpp.

ConditionInterface * RTT::ConditionInterface::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned ) const

virtualinherited

When copying an Orocos program, we want identical internal::DataSource's to be mapped to identical DataSources, in order for the program to work correctly.

This is different from the clone function, where we simply want a new Command that can replace the old one directly.

This function takes a map that maps the old internal::DataSource's onto their new replacements. This way, it is possible to check before cloning a internal::DataSource, whether it has already been copied, and if so, reuse the existing copy.

To keep old source working, the standard implementation of this function simply calls the clone function. If your ConditionInterface uses a internal::DataSource, it is important that you reimplement this function correctly though.

Reimplemented in RTT::scripting::EvalCommandResult, RTT::scripting::ConditionCompositeNOT, RTT::scripting::ConditionBinaryCompositeOR, RTT::scripting::TryCommandResult, RTT::scripting::ConditionCache, RTT::scripting::ConditionDSDuration, RTT::scripting::ConditionCompare< T, compare_op >, RTT::scripting::ConditionInvert, RTT::scripting::ConditionBoolDataSource, and RTT::scripting::ConditionBinaryCompositeAND.

Definition at line 50 of file ConditionInterface.cpp.

Referenced by RTT::scripting::ParsedStateMachine::copy(), RTT::scripting::ConditionBinaryCompositeAND::copy(), RTT::scripting::DataSourceCondition::copy(), and RTT::scripting::ConditionBinaryCompositeOR::copy().

virtual bool RTT::scripting::ConditionFunction::evaluate ( )

inlinevirtual

Evaluate the Condition and return the outcome.

Returns

true if the condition is satisfied, false otherwise.

Implements RTT::scripting::ConditionInterface.

Definition at line 104 of file CommandFunctors.hpp.

void RTT::ConditionInterface::reset ( )

virtualinherited

Some conditions need to be reset at some points.

E.g. a scripting::ConditionDuration counts the time since the first time a Command was executed, and if this time exceeds a certain preset time, returns true. Therefore, it needs to be reset, i.e. it needs to start counting, when the command is first executed.. scripting::ConditionOnce has a similar need. This function is called at such times.

Reimplemented in RTT::scripting::ConditionCompositeNOT, RTT::scripting::ConditionBinaryCompositeOR, RTT::scripting::ConditionBinaryCompositeAND, RTT::scripting::ConditionExpire, RTT::scripting::ConditionDSDuration, RTT::scripting::ConditionCache, RTT::scripting::ConditionDuration, RTT::scripting::ConditionBoolDataSource, and RTT::scripting::ConditionOnce.

Definition at line 47 of file ConditionInterface.cpp.

Referenced by RTT::scripting::Parser::parseCondition(), RTT::scripting::DataSourceCondition::reset(), RTT::scripting::ConditionBinaryCompositeAND::reset(), RTT::scripting::EdgeCondition::reset(), and RTT::scripting::ConditionBinaryCompositeOR::reset().

Member Data Documentation

Function RTT::scripting::ConditionFunction::con

Definition at line 93 of file CommandFunctors.hpp.

bool RTT::scripting::ConditionFunction::minvert

Definition at line 94 of file CommandFunctors.hpp.

---

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

• rtt/scripting/CommandFunctors.hpp