RTT::AsynchCommandDecorator Class Reference

Based on the software patterns 'command' and 'decorator', this interface represents a wrapper around a given command, which decorates that command as an asynchronous command. More...

#include <rtt/AsynchCommandDecorator.hpp>

Inherits RTT::Corba::CommandInterface.

List of all members.

Public Types

typedef CommandInterface_ptr _ptr_type
typedef CommandInterface_var _var_type
typedef CommandInterface_out _out_type

Public Member Functions

 AsynchCommandDecorator (CommandInterface *cmd)
 Construct a new decorator with given command.
 AsynchCommandDecorator (const AsynchCommandDecorator &orig)
void readArguments ()
virtual bool execute ()
 Execute the functionality of the corresponding command.
virtual void reset ()
const CommandInterfacegetCommand () const
virtual CommandInterfaceclone () const
virtual CommandInterfacecopy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const
virtual ::RTT::Corba::CommandList * getCommands (void)
virtual
::RTT::Corba::Descriptions * 
getArguments (const char *command)
virtual char * getResultType (const char *command)
virtual char * getDescription (const char *command)
virtual ::RTT::Corba::Command_ptr createCommand (const char *command, const ::RTT::Corba::Arguments &args)
virtual ::RTT::Corba::Command_ptr createCommandAny (const char *command, const ::RTT::Corba::AnyArguments &args)
virtual ::CORBA::Boolean _is_a (const char *type_id)
virtual const char * _interface_repository_id (void) const
virtual ::CORBA::Boolean marshal (TAO_OutputCDR &cdr)

Static Public Member Functions

static CommandInterface_ptr _duplicate (CommandInterface_ptr obj)
static void _tao_release (CommandInterface_ptr obj)
static CommandInterface_ptr _narrow (::CORBA::Object_ptr obj)
static CommandInterface_ptr _unchecked_narrow (::CORBA::Object_ptr obj)
static CommandInterface_ptr _nil (void)
static void _tao_any_destructor (void *)

Protected Member Functions

virtual void RTT_Corba_CommandInterface_setup_collocation (void)

Friends

class TAO::Narrow_Utils< CommandInterface >

Detailed Description

Based on the software patterns 'command' and 'decorator', this interface represents a wrapper around a given command, which decorates that command as an asynchronous command.

The command will be executed once, until reset() and the result of this invocation will be returned.

If the command fails when executed, no more attempts will be done to execute it again, and execute() will return false until the AsynchCommandDecorator is reset().

Definition at line 64 of file AsynchCommandDecorator.hpp.


Constructor & Destructor Documentation

RTT::AsynchCommandDecorator::AsynchCommandDecorator ( CommandInterface cmd  ) 

Construct a new decorator with given command.

Precondition:
cmd != 0
Parameters:
cmd The command to be decorated
Postcondition:
The given command is decorated as an asynchronous command.

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