A conditional that evaluates true until a certain time has elapsed since construction or the last reset() More...
#include <rtt/scripting/ConditionExpire.hpp>
Public Member Functions | |
| ConditionExpire (ticks t) | |
| Create a Condition that evaluates to false when t is reached. | |
| virtual bool | evaluate () |
| Evaluate the Condition and return the outcome. | |
| virtual void | reset () |
| Some conditions need to be reset at some points. | |
| virtual ConditionInterface * | clone () const |
| The Clone Software Pattern. | |
| 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. | |
Detailed Description
A conditional that evaluates true until a certain time has elapsed since construction or the last reset()
Definition at line 54 of file ConditionExpire.hpp.
Constructor & Destructor Documentation
| RTT::scripting::ConditionExpire::ConditionExpire | ( | ticks | t | ) | [inline] |
Create a Condition that evaluates to false when t is reached.
- Parameters:
-
t the time in os::TimeService::ticks on and after which the condition will evaluate to false
Definition at line 65 of file ConditionExpire.hpp.
Member Function Documentation
| ConditionInterface * RTT::ConditionInterface::copy | ( | std::map< const base::DataSourceBase *, base::DataSourceBase * > & | alreadyCloned | ) | const [virtual, inherited] |
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::TryCommandResult, RTT::scripting::ConditionCache, RTT::scripting::ConditionDSDuration, RTT::scripting::ConditionInvert, RTT::scripting::ConditionCompare< T, compare_op >, RTT::scripting::ConditionBoolDataSource, and RTT::scripting::ConditionBinaryCompositeAND.
Definition at line 50 of file ConditionInterface.cpp.
Referenced by RTT::scripting::ParsedStateMachine::copy(), and RTT::scripting::DataSourceCondition::copy().
| virtual bool RTT::scripting::ConditionExpire::evaluate | ( | ) | [inline, virtual] |
Evaluate the Condition and return the outcome.
- Returns:
- true if the condition is satisfied, false otherwise.
Implements RTT::scripting::ConditionInterface.
Definition at line 74 of file ConditionExpire.hpp.
| virtual void RTT::scripting::ConditionExpire::reset | ( | ) | [inline, virtual] |
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 from RTT::scripting::ConditionInterface.
Definition at line 79 of file ConditionExpire.hpp.
The documentation for this class was generated from the following file:
- rtt/scripting/ConditionExpire.hpp
