The result of a command which evaluates a boolean DataSource. More...
#include <rtt/scripting/TryCommand.hpp>
Public Member Functions | |
| EvalCommandResult (internal::DataSource< bool >::shared_ptr ec) | |
| ~EvalCommandResult () | |
| bool | evaluate () |
| Evaluate the Condition and return the outcome. More... | |
| ConditionInterface * | clone () const |
| The Clone Software Pattern. More... | |
| 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... | |
| virtual void | reset () |
| Some conditions need to be reset at some points. More... | |
Detailed Description
The result of a command which evaluates a boolean DataSource.
- See also
- EvalCommand
Definition at line 157 of file TryCommand.hpp.
Constructor & Destructor Documentation
| RTT::EvalCommandResult::EvalCommandResult | ( | internal::DataSource< bool >::shared_ptr | ec | ) |
Definition at line 166 of file TryCommand.cpp.
| RTT::EvalCommandResult::~EvalCommandResult | ( | ) |
Definition at line 169 of file TryCommand.cpp.
Member Function Documentation
|
virtual |
The Clone Software Pattern.
Implements RTT::scripting::ConditionInterface.
Definition at line 177 of file TryCommand.cpp.
References EvalCommandResult().
|
virtual |
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 from RTT::scripting::ConditionInterface.
Definition at line 181 of file TryCommand.cpp.
References RTT::internal::DataSource< T >::copy(), and EvalCommandResult().
|
virtual |
Evaluate the Condition and return the outcome.
- Returns
- true if the condition is satisfied, false otherwise.
Implements RTT::scripting::ConditionInterface.
Definition at line 173 of file TryCommand.cpp.
References RTT::internal::DataSource< T >::get().
|
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::CmdCollectCondition, 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().
The documentation for this class was generated from the following files:
- rtt/scripting/TryCommand.hpp
- rtt/scripting/TryCommand.cpp
