This command increments a counter when executed. More...
#include <CommandCounter.hpp>
Public Member Functions | |
| virtual base::ActionInterface * | clone () const |
| CommandCounter () | |
| virtual bool | execute () |
| virtual int | getCounter () |
| virtual void | readArguments () |
| virtual void | reset () |
| virtual | ~CommandCounter () |
Private Attributes | |
| int | counter |
Detailed Description
This command increments a counter when executed.
- Deprecated:
- Remove this low-level class since it's nowhere used.
Definition at line 52 of file CommandCounter.hpp.
Constructor & Destructor Documentation
Definition at line 42 of file CommandCounter.cpp.
| RTT::CommandCounter::~CommandCounter | ( | ) | [virtual] |
Definition at line 47 of file CommandCounter.cpp.
Member Function Documentation
| virtual base::ActionInterface* RTT::scripting::CommandCounter::clone | ( | ) | const [inline, virtual] |
The Clone Software Pattern.
Implements RTT::base::ActionInterface.
Definition at line 77 of file CommandCounter.hpp.
| bool RTT::CommandCounter::execute | ( | ) | [virtual] |
Execute the functionality of this action.
- Returns:
- true if the action was accepted, false otherwise
Implements RTT::base::ActionInterface.
Definition at line 54 of file CommandCounter.cpp.
| int RTT::CommandCounter::getCounter | ( | ) | [virtual] |
return the number of times this command has been executed since the last reset
Definition at line 65 of file CommandCounter.cpp.
| void RTT::CommandCounter::readArguments | ( | ) | [virtual] |
This is invoked some time before execute() at a time when the action may read its function arguments.
Implements RTT::base::ActionInterface.
Definition at line 51 of file CommandCounter.cpp.
| void RTT::CommandCounter::reset | ( | ) | [virtual] |
set number of times executed to zero
Reimplemented from RTT::base::ActionInterface.
Definition at line 60 of file CommandCounter.cpp.
Member Data Documentation
int RTT::scripting::CommandCounter::counter [private] |
Definition at line 83 of file CommandCounter.hpp.
The documentation for this class was generated from the following files: