RTT::ConditionInterface Class Reference
This interface represents the concept of a condition which can be evaluated and return true or false. More...
#include <rtt/ConditionInterface.hpp>
Public Member Functions | |
| virtual bool | evaluate ()=0 |
| Evaluate the Condition and return the outcome. | |
| virtual void | reset () |
| Some conditions need to be reset at some points. | |
| virtual ConditionInterface * | clone () const =0 |
| The Clone Software Pattern. | |
| virtual ConditionInterface * | copy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const |
| When copying an Orocos program, we want identical DataSource's to be mapped to identical DataSources, in order for the program to work correctly. | |
Detailed Description
This interface represents the concept of a condition which can be evaluated and return true or false.
- Todo:
- This class is a light-weight implementation of a DataSource<bool>. It may be profitable to remove this low level class and replace its use by DataSource<bool>. That would also cause the removal of most Condition* classes.
Definition at line 61 of file ConditionInterface.hpp.
Member Function Documentation
| virtual ConditionInterface* RTT::ConditionInterface::copy | ( | std::map< const DataSourceBase *, DataSourceBase * > & | alreadyCloned | ) | const [virtual] |
When copying an Orocos program, we want identical 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 DataSource's onto their new replacements. This way, it is possible to check before cloning a 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 DataSource, it is important that you reimplement this function correctly though.
Reimplemented in RTT::ConditionExecFunction, RTT::detail::ConditionFunctor< SignatureT, FunctorT >, RTT::ConditionBoolDataSource, RTT::ConditionBinaryCompositeAND, RTT::ConditionDSDuration, RTT::ConditionInvert, RTT::TryCommandResult, and RTT::EvalCommandResult.
| virtual bool RTT::ConditionInterface::evaluate | ( | ) | [pure virtual] |
Evaluate the Condition and return the outcome.
- Returns:
- true if the condition is satisfied, false otherwise.
Implemented in RTT::ConditionExecFunction, RTT::detail::ConditionFunctor< SignatureT, FunctorT >, RTT::detail::ConditionFunction, RTT::ConditionBoolDataSource, RTT::ConditionBoolProperty, RTT::ConditionCompare< T, compare_op >, RTT::ConditionBinaryCompositeAND, RTT::ConditionDSDuration, RTT::ConditionDuration, RTT::ConditionExpire, RTT::ConditionFalse, RTT::ConditionInvert, RTT::ConditionOnce, RTT::ConditionTrue, RTT::TryCommandResult, and RTT::EvalCommandResult.
| virtual void RTT::ConditionInterface::reset | ( | ) | [virtual] |
Some conditions need to be reset at some points.
E.g. a 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.. ConditionOnce has a similar need. This function is called at such times.
Reimplemented in RTT::ConditionBoolDataSource, RTT::ConditionBinaryCompositeAND, RTT::ConditionDSDuration, RTT::ConditionDuration, RTT::ConditionExpire, and RTT::ConditionOnce.
The documentation for this class was generated from the following file:
