RTT::detail::LocalCommand< CommandT > Class Template Reference

A Command which is dispatched locally to a CommandProcessor. More...

#include <rtt/LocalCommand.hpp>

Inheritance diagram for RTT::detail::LocalCommand< CommandT >:
RTT::detail::Invoker< CommandT, LocalCommandImpl< CommandT > >

List of all members.

Public Types

typedef CommandT Signature

Public Member Functions

template<class CommandF , class ConditionF , class ObjectT >
 LocalCommand (CommandF com, ConditionF con, ObjectT t, bool invert=false)
 Create a LocalCommand object which executes a member function of a class that inherits from a TaskContext.
template<class CommandF , class ConditionF , class ObjectT >
 LocalCommand (CommandF com, ConditionF con, ObjectT t, CommandProcessor *commandp, bool invert=false)
 Create a LocalCommand object which executes a member function of a class that is not a TaskContext.
template<class CommandF , class ConditionF >
 LocalCommand (CommandF com, ConditionF con, CommandProcessor *commandp, bool invert=false)
 Create a LocalCommand object which executes a plain 'C' function.
virtual void readArguments ()
virtual bool ready () const
virtual bool dispatch ()
virtual bool execute ()
virtual bool done () const
virtual void reset ()
virtual bool sent () const
virtual bool accepted () const
virtual bool executed () const
virtual bool valid () const
virtual ConditionInterfacecreateCondition () const
virtual DispatchInterfaceclone () const
 Creates a clone of this LocalCommand object.
virtual CommandBase< CommandT > * cloneI () const
boost::function< CommandT > getCommandFunction () const
boost::function< CommandT > getConditionFunction () const

Detailed Description

template<class CommandT>
class RTT::detail::LocalCommand< CommandT >

A Command which is dispatched locally to a CommandProcessor.

Parameters:
CommandT The function signature of the command. For example, bool( int, Frame, double)

Definition at line 150 of file LocalCommand.hpp.


Constructor & Destructor Documentation

template<class CommandT>
template<class CommandF , class ConditionF , class ObjectT >
RTT::detail::LocalCommand< CommandT >::LocalCommand ( CommandF  com,
ConditionF  con,
ObjectT  t,
bool  invert = false 
) [inline]

Create a LocalCommand object which executes a member function of a class that inherits from a TaskContext.

Parameters:
name The name of this command.
com A pointer to the member function to execute when the command is invoked.
con A pointer to the member function that evaluates if the command is done.
t A pointer to an object of this class, which will receive and process the command.
invert Invert the result of con when evaluating the completion of the command.

Definition at line 168 of file LocalCommand.hpp.

Referenced by RTT::detail::LocalCommand< CommandT >::clone().

template<class CommandT>
template<class CommandF , class ConditionF , class ObjectT >
RTT::detail::LocalCommand< CommandT >::LocalCommand ( CommandF  com,
ConditionF  con,
ObjectT  t,
CommandProcessor commandp,
bool  invert = false 
) [inline]

Create a LocalCommand object which executes a member function of a class that is not a TaskContext.

Parameters:
name The name of this command.
com A pointer to the member function to execute when the command is invoked.
con A pointer to the member function that evaluates if the command is done.
t A pointer to an object of the class which has com and con.
commandp The CommandProcessor which will execute this LocalCommand.
invert Invert the result of con when evaluating the completion of the command.

Definition at line 189 of file LocalCommand.hpp.

template<class CommandT>
template<class CommandF , class ConditionF >
RTT::detail::LocalCommand< CommandT >::LocalCommand ( CommandF  com,
ConditionF  con,
CommandProcessor commandp,
bool  invert = false 
) [inline]

Create a LocalCommand 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 LocalCommand.
invert Invert the result of con when evaluating the completion of the command.

Definition at line 206 of file LocalCommand.hpp.


Member Function Documentation

template<class CommandT>
virtual DispatchInterface* RTT::detail::LocalCommand< CommandT >::clone (  )  const [inline, virtual]

Creates a clone of this LocalCommand object.

Use this method to get a new command object which has its own state information.

Returns:

Definition at line 281 of file LocalCommand.hpp.

References RTT::detail::LocalCommand< CommandT >::LocalCommand().


The documentation for this class was generated from the following file:
Generated on Thu Dec 23 13:22:46 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3