The interface class for operation callers. More...
#include <rtt/base/OperationCallerInterface.hpp>
Public Types | |
|
typedef boost::shared_ptr < OperationCallerInterface > | shared_ptr |
| Use this type for shared pointer storage of an OperationCallerInterface object. | |
Public Member Functions | |
| virtual bool | ready () const =0 |
| Available such that implementations have a way to expose their ready-ness, ie being able to do the call. | |
| virtual void | setExecutor (ExecutionEngine *ee)=0 |
| Set an executor which will execute this method when it is called or sent. | |
| virtual void | setCaller (ExecutionEngine *ee)=0 |
| Sets the caller's engine of this operation. | |
| virtual bool | setThread (ExecutionThread et, ExecutionEngine *executor)=0 |
| Sets the Thread execution policy of this object. | |
| virtual void | executeAndDispose ()=0 |
| Execute functionality and free this object. | |
| virtual void | dispose ()=0 |
| Just free this object without executing it. | |
Detailed Description
The interface class for operation callers.
Definition at line 15 of file OperationCallerInterface.hpp.
Member Function Documentation
| virtual void RTT::base::DisposableInterface::executeAndDispose | ( | ) | [pure virtual, inherited] |
Execute functionality and free this object.
You may no longer use this object after calling this method.
Implemented in RTT::internal::LocalOperationCallerImpl< FunctionT >, and RTT::internal::RemoteOperationCallerImpl< OperationCallerT >.
| virtual void RTT::base::OperationCallerInterface::setCaller | ( | ExecutionEngine * | ee | ) | [pure virtual] |
Sets the caller's engine of this operation.
This object will be used to test if asynchronous messaging is required.
- Parameters:
-
ee The ExecutionEngine of the component that is calling this operation.
Implemented in RTT::internal::RemoteOperationCallerImpl< OperationCallerT >, and RTT::internal::LocalOperationCallerImpl< FunctionT >.
| virtual void RTT::base::OperationCallerInterface::setExecutor | ( | ExecutionEngine * | ee | ) | [pure virtual] |
Set an executor which will execute this method when it is called or sent.
If ee is set to 0, the method will be executed in the client's thread or the GlobalExecutionEngine.
- Parameters:
-
ee The ExecutionEngine of the component that is executing this operation.
Implemented in RTT::internal::RemoteOperationCallerImpl< OperationCallerT >, and RTT::internal::LocalOperationCallerImpl< FunctionT >.
| virtual bool RTT::base::OperationCallerInterface::setThread | ( | ExecutionThread | et, |
| ExecutionEngine * | executor | ||
| ) | [pure virtual] |
Sets the Thread execution policy of this object.
- Parameters:
-
et OwnThread or ClientThread. executor The engine of the component owning this operation. In case it is not yet owned by a component, executor may be null.
- Returns:
- false if it may not be modified.
Implemented in RTT::internal::LocalOperationCallerImpl< FunctionT >.
Referenced by RTT::Service::setOperationThread().
The documentation for this struct was generated from the following file:
- rtt/base/OperationCallerInterface.hpp
