RTT::CommandDS< CommandT > Class Template Reference
A Command storage container. More...
#include <rtt/CommandDS.hpp>
Inheritance diagram for RTT::CommandDS< CommandT >:
Public Types | |
| typedef CommandT | Signature |
Public Member Functions | |
| template<class CommandF , class ConditionF > | |
| CommandDS (std::string name, CommandF com, ConditionF con, CommandProcessor *commandp, bool invert=false) | |
| Create a Command object which executes a plain 'C' function. | |
| boost::function< CommandT > | getCommandFunction () const |
| boost::function< CommandT > | getConditionFunction () const |
| bool | isInverted () const |
| Returns true if the condition is inverted. | |
| CommandProcessor * | getCommandProcessor () const |
| Returns a pointer to the CommandProcessor which will process this command. | |
| const std::string & | getName () const |
| Returns the name of this Command object. | |
Protected Attributes | |
| std::string | mname |
| CommandProcessor * | mcp |
| bool | minvert |
Detailed Description
template<class CommandT>
class RTT::CommandDS< CommandT >
A Command storage container.
Definition at line 54 of file CommandDS.hpp.
Constructor & Destructor Documentation
template<class CommandT >
template<class CommandF , class ConditionF >
| RTT::CommandDS< CommandT >::CommandDS | ( | std::string | name, | |
| CommandF | com, | |||
| ConditionF | con, | |||
| CommandProcessor * | commandp, | |||
| bool | invert = false | |||
| ) | [inline] |
Create a Command object which executes a plain 'C' function.
- Parameters:
-
name The name of this command. com A pointer to the 'C' function to execute when the command is invoked. con A pointer to the 'C' function that evaluates if the command is done. commandp The CommandProcessor which will execute this Command. invert Invert the result of con when evaluating the completion of the command.
Definition at line 76 of file CommandDS.hpp.
Member Function Documentation
template<class CommandT >
| CommandProcessor* RTT::CommandDS< CommandT >::getCommandProcessor | ( | ) | const [inline] |
Returns a pointer to the CommandProcessor which will process this command.
- Returns:
- the pointer.
Definition at line 107 of file CommandDS.hpp.
template<class CommandT >
| const std::string& RTT::CommandDS< CommandT >::getName | ( | ) | const [inline] |
Returns the name of this Command object.
- Returns:
- the name.
Definition at line 116 of file CommandDS.hpp.
template<class CommandT >
| bool RTT::CommandDS< CommandT >::isInverted | ( | ) | const [inline] |
Returns true if the condition is inverted.
- Returns:
- true if inverted
Definition at line 97 of file CommandDS.hpp.
The documentation for this class was generated from the following file:
- rtt/CommandDS.hpp
