RTT::Corba::CommandProxy Class Reference
This class manages the access of remote Command Corba Servers. More...
#include <rtt/corba/CommandProxy.hpp>
Public Types | |
| enum | Status { NotReady, Ready, Sent, NotAccepted, Accepted, Executed, NotValid, Valid, Done } |
The status progressions of a Dispatchable Command. More... | |
|
typedef boost::shared_ptr < DispatchInterface > | shared_ptr |
| If you want to share ownership of DispatchInterface instances, use this shared_ptr type. | |
| typedef CommandInterface_ptr | _ptr_type |
| typedef CommandInterface_var | _var_type |
| typedef CommandInterface_out | _out_type |
Public Member Functions | |
| Corba::Command_ptr | server () const |
| Get the Corba Object reference of the Command. | |
| virtual void | readArguments () |
| virtual bool | ready () const |
| The command's effect is done. | |
| virtual bool | dispatch () |
| Dispatch a command. | |
| virtual bool | execute () |
| virtual void | reset () |
| After reset(), another attempt to dispatch the command will be made upon execute(). | |
| virtual bool | sent () const |
| Returns true if the command was sent to the CommandProcessor. | |
| virtual bool | accepted () const |
| Returns true if the command was accepted when sent to the CommandProcessor. | |
| virtual bool | executed () const |
| Returns true if the command was executed by the CommandProcessor. | |
| virtual bool | valid () const |
| Returns true if the command was valid, i.e. | |
| virtual bool | done () const |
| Returns true if the command is done. | |
| virtual ConditionInterface * | createCondition () const |
| virtual CommandProxy * | clone () const |
| virtual CommandProxy * | copy (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 CommandProxy * | Create (::RTT::Corba::Command_ptr act) |
| Factory method: create a CORBA connection to an existing Command Object. | |
| 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 | |
| CommandProxy (::RTT::Corba::Command_ptr t) | |
| Private constructor which creates a new connection to a corba object. | |
| virtual void | RTT_Corba_CommandInterface_setup_collocation (void) |
Protected Attributes | |
| Corba::Command_var | mdata |
Friends | |
| class | TAO::Narrow_Utils< CommandInterface > |
Detailed Description
This class manages the access of remote Command Corba Servers.
Definition at line 52 of file CommandProxy.hpp.
Member Enumeration Documentation
enum RTT::DispatchInterface::Status [inherited] |
The status progressions of a Dispatchable Command.
The order of these enums is important and should not be altered.
- Enumerator:
Ready The command is not yet initialised.
Sent The command is ready for execution.
NotAccepted The command has been sent/dispatched to the CommandProcessor.
Accepted The command was not accepted by the CommandProcessor.
Executed The command was accepted by the CommandProcessor.
NotValid The command was executed by the CommandProcessor.
Valid The command's arguments were found to be invalid.
Done The command's arguments were valid.
Definition at line 65 of file DispatchInterface.hpp.
Member Function Documentation
| virtual bool RTT::Corba::CommandProxy::accepted | ( | ) | const [inline, virtual] |
Returns true if the command was accepted when sent to the CommandProcessor.
A Command is accepted when the CommandProcessor was running and its queue was not full.
Implements RTT::DispatchInterface.
Definition at line 103 of file CommandProxy.hpp.
| static CommandProxy* RTT::Corba::CommandProxy::Create | ( | ::RTT::Corba::Command_ptr | act | ) | [static] |
Factory method: create a CORBA connection to an existing Command Object.
- Parameters:
-
act The Object to connect to.
- Returns:
- A new or previously created CORBA proxy for act.
| virtual bool RTT::Corba::CommandProxy::dispatch | ( | ) | [inline, virtual] |
Dispatch a command.
If it is not accepted, fail, if it is accepted, return true
Implements RTT::DispatchInterface.
Definition at line 87 of file CommandProxy.hpp.
| virtual bool RTT::Corba::CommandProxy::executed | ( | ) | const [inline, virtual] |
Returns true if the command was executed by the CommandProcessor.
When executed() is true, you can check if it was found valid().
Implements RTT::DispatchInterface.
Definition at line 107 of file CommandProxy.hpp.
| virtual bool RTT::Corba::CommandProxy::ready | ( | ) | const [inline, virtual] |
The command's effect is done.
Returns true if the command is ready for dispatch. If ready() returns true, dispatch() can be safely called, otherwise, dispatch() will fail.
Implements RTT::DispatchInterface.
Definition at line 83 of file CommandProxy.hpp.
| virtual bool RTT::Corba::CommandProxy::sent | ( | ) | const [inline, virtual] |
Returns true if the command was sent to the CommandProcessor.
You can use this flag to check whether execute() was invoked.
Implements RTT::DispatchInterface.
Definition at line 99 of file CommandProxy.hpp.
| Corba::Command_ptr RTT::Corba::CommandProxy::server | ( | ) | const |
| virtual bool RTT::Corba::CommandProxy::valid | ( | ) | const [inline, virtual] |
Returns true if the command was valid, i.e.
the command itself was executed and returned true.
Implements RTT::DispatchInterface.
Definition at line 111 of file CommandProxy.hpp.
The documentation for this class was generated from the following file:
- rtt/corba/CommandProxy.hpp
