#include <OperationCallerInterface.hpp>
Public Types | |
| typedef boost::shared_ptr < OperationCallerInterface > | shared_ptr |
| typedef boost::shared_ptr < OperationCallerInterface > | shared_ptr |
Public Member Functions | |
| virtual bool | ready () const =0 |
| virtual bool | ready () const =0 |
| virtual void | setCaller (ExecutionEngine *ee)=0 |
| virtual void | setCaller (ExecutionEngine *ee)=0 |
| virtual void | setExecutor (ExecutionEngine *ee)=0 |
| virtual void | setExecutor (ExecutionEngine *ee)=0 |
| virtual bool | setThread (ExecutionThread et, ExecutionEngine *executor)=0 |
| virtual bool | setThread (ExecutionThread et, ExecutionEngine *executor)=0 |
| virtual | ~OperationCallerInterface () |
| virtual | ~OperationCallerInterface () |
The interface class for operation callers.
Definition at line 15 of file install/include/rtt/base/OperationCallerInterface.hpp.
| typedef boost::shared_ptr<OperationCallerInterface> RTT::base::OperationCallerInterface::shared_ptr |
Use this type for shared pointer storage of an OperationCallerInterface object.
Reimplemented from RTT::base::DisposableInterface.
Reimplemented in RTT::base::OperationCallerBase< F >, RTT::internal::LocalOperationCallerImpl< FunctionT >, RTT::base::OperationCallerBase< F >, RTT::internal::LocalOperationCallerImpl< FunctionT >, RTT::base::OperationCallerBase< OperationCallerT >, RTT::base::OperationCallerBase< OperationCallerT >, RTT::base::OperationCallerBase< Signature >, RTT::base::OperationCallerBase< Signature >, RTT::base::OperationCallerBase< FunctionT >, and RTT::base::OperationCallerBase< FunctionT >.
Definition at line 21 of file rtt/base/OperationCallerInterface.hpp.
| typedef boost::shared_ptr<OperationCallerInterface> RTT::base::OperationCallerInterface::shared_ptr |
Use this type for shared pointer storage of an OperationCallerInterface object.
Reimplemented from RTT::base::DisposableInterface.
Reimplemented in RTT::base::OperationCallerBase< F >, RTT::internal::LocalOperationCallerImpl< FunctionT >, RTT::base::OperationCallerBase< F >, RTT::internal::LocalOperationCallerImpl< FunctionT >, RTT::base::OperationCallerBase< OperationCallerT >, RTT::base::OperationCallerBase< OperationCallerT >, RTT::base::OperationCallerBase< Signature >, RTT::base::OperationCallerBase< Signature >, RTT::base::OperationCallerBase< FunctionT >, and RTT::base::OperationCallerBase< FunctionT >.
Definition at line 21 of file install/include/rtt/base/OperationCallerInterface.hpp.
| virtual RTT::base::OperationCallerInterface::~OperationCallerInterface | ( | ) | [inline, virtual] |
Definition at line 23 of file install/include/rtt/base/OperationCallerInterface.hpp.
| virtual RTT::base::OperationCallerInterface::~OperationCallerInterface | ( | ) | [inline, virtual] |
Definition at line 23 of file rtt/base/OperationCallerInterface.hpp.
| virtual bool RTT::base::OperationCallerInterface::ready | ( | ) | const [pure virtual] |
Available such that implementations have a way to expose their ready-ness, ie being able to do the call.
Implemented in RTT::internal::LocalOperationCallerImpl< FunctionT >, and RTT::internal::LocalOperationCallerImpl< FunctionT >.
| virtual bool RTT::base::OperationCallerInterface::ready | ( | ) | const [pure virtual] |
Available such that implementations have a way to expose their ready-ness, ie being able to do the call.
Implemented in RTT::internal::LocalOperationCallerImpl< FunctionT >, and RTT::internal::LocalOperationCallerImpl< FunctionT >.
| 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.
| ee | The ExecutionEngine of the component that is calling this operation. |
Implemented in RTT::internal::LocalOperationCallerImpl< FunctionT >, RTT::internal::RemoteOperationCallerImpl< OperationCallerT >, 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.
| ee | The ExecutionEngine of the component that is calling this operation. |
Implemented in RTT::internal::LocalOperationCallerImpl< FunctionT >, RTT::internal::RemoteOperationCallerImpl< OperationCallerT >, RTT::internal::LocalOperationCallerImpl< FunctionT >, and RTT::internal::RemoteOperationCallerImpl< OperationCallerT >.
| 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.
| ee | The ExecutionEngine of the component that is executing this operation. |
Implemented in RTT::internal::LocalOperationCallerImpl< FunctionT >, RTT::internal::RemoteOperationCallerImpl< OperationCallerT >, RTT::internal::LocalOperationCallerImpl< FunctionT >, and RTT::internal::RemoteOperationCallerImpl< OperationCallerT >.
| 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.
| ee | The ExecutionEngine of the component that is executing this operation. |
Implemented in RTT::internal::LocalOperationCallerImpl< FunctionT >, RTT::internal::RemoteOperationCallerImpl< OperationCallerT >, RTT::internal::LocalOperationCallerImpl< FunctionT >, and RTT::internal::RemoteOperationCallerImpl< OperationCallerT >.
| virtual bool RTT::base::OperationCallerInterface::setThread | ( | ExecutionThread | et, | |
| ExecutionEngine * | executor | |||
| ) | [pure virtual] |
Sets the Thread execution policy of this object.
| 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. |
Implemented in RTT::internal::LocalOperationCallerImpl< FunctionT >, 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.
| 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. |
Implemented in RTT::internal::LocalOperationCallerImpl< FunctionT >, and RTT::internal::LocalOperationCallerImpl< FunctionT >.
