RTT::DLib::DLibCommand< CommandT, ProtocolT > Class Template Reference

A Command which is dispatched using the 'Distribution Library' to a CommandProcessor. More...

#include <rtt/dlib/DLibCommand.hpp>

Inheritance diagram for RTT::DLib::DLibCommand< CommandT, ProtocolT >:
RTT::detail::Invoker< CommandT, DLibCommandImpl< CommandT, ProtocolT > >

List of all members.

Public Types

typedef CommandT Signature

Public Member Functions

 DLibCommand (std::string component, std::string name, ProtocolT *_protocol)
 Create a DLibCommand object which executes a remote command.
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 DLibCommand object.
virtual detail::CommandBase
< CommandT > * 
cloneI () const

Detailed Description

template<class CommandT, class ProtocolT>
class RTT::DLib::DLibCommand< CommandT, ProtocolT >

A Command which is dispatched using the 'Distribution Library' to a CommandProcessor.

It inherits from the DLibCommandImpl class.

Parameters:
CommandT The function signature of the command. For example, bool( int, Frame, double)
ProtocolT A class containing static functions which implement the DLib Command Protocol.

Definition at line 139 of file DLibCommand.hpp.


Constructor & Destructor Documentation

template<class CommandT , class ProtocolT >
RTT::DLib::DLibCommand< CommandT, ProtocolT >::DLibCommand ( std::string  component,
std::string  name,
ProtocolT *  _protocol 
) [inline]

Create a DLibCommand object which executes a remote command.

Parameters:
component The name of the target component.
name The name of this command.

Definition at line 151 of file DLibCommand.hpp.

Referenced by RTT::DLib::DLibCommand< CommandT, ProtocolT >::clone().


Member Function Documentation

template<class CommandT , class ProtocolT >
virtual DispatchInterface* RTT::DLib::DLibCommand< CommandT, ProtocolT >::clone (  )  const [inline, virtual]

Creates a clone of this DLibCommand object.

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

Returns:

Definition at line 211 of file DLibCommand.hpp.

References RTT::DLib::DLibCommand< CommandT, ProtocolT >::DLibCommand().


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