Orocos Real-Time Toolkit
2.9.0
|
A OperationCaller serves as a placeholder (aka 'proxy') for a remote Operation. More...
#include <rtt/OperationCaller.hpp>
Public Types | |
typedef SignatureT | Signature |
typedef internal::InvokerSignature< boost::function_traits< Signature >::arity, Signature, boost::shared_ptr< base::OperationCallerBase< Signature > > > | Base |
typedef boost::function_traits< Signature >::result_type | result_type |
typedef boost::function_traits< Signature > | traits |
typedef boost::shared_ptr< base::OperationCallerBase< Signature > > | OperationCallerBasePtr |
Public Member Functions | |
OperationCaller () | |
Create an empty OperationCaller object. More... | |
OperationCaller (std::string name, ExecutionEngine *caller=0) | |
Create an OperationCaller object with a name and optional caller. More... | |
OperationCaller (const OperationCaller &m) | |
OperationCaller objects may be copied. More... | |
OperationCaller & | operator= (const OperationCaller &m) |
OperationCaller objects may be assigned. More... | |
OperationCaller (boost::shared_ptr< base::DisposableInterface > implementation, ExecutionEngine *caller=0) | |
Initialise a nameless OperationCaller object from a local Operation. More... | |
OperationCaller (OperationInterfacePart *part, ExecutionEngine *caller=0) | |
Initialise a nameless OperationCaller object from an operation factory. More... | |
OperationCaller (const std::string &name, ServicePtr service, ExecutionEngine *caller=0) | |
Initialise a named OperationCaller object from a Service. More... | |
OperationCaller & | operator= (boost::shared_ptr< base::DisposableInterface > implementation) |
OperationCaller objects may be assigned to an implementation. More... | |
OperationCaller & | operator= (OperationInterfacePart *part) |
OperationCaller objects may be assigned to a part responsible for production of an implementation. More... | |
OperationCaller & | operator= (ServicePtr service) |
Named OperationCaller objects may be looked up in a Service. More... | |
~OperationCaller () | |
Clean up the OperationCaller object. More... | |
bool | ready () const |
Check if this OperationCaller is ready for execution. More... | |
std::string const & | getName () const |
Get the name of this OperationCaller. More... | |
bool | setImplementation (boost::shared_ptr< base::DisposableInterface > implementation, ExecutionEngine *caller=0) |
Sets a new implementation for this method. More... | |
bool | setImplementationPart (OperationInterfacePart *orp, ExecutionEngine *caller=0) |
Sets a new implementation for this method by using a service part. More... | |
const OperationCallerBasePtr | getOperationCallerImpl () const |
Returns the internal implementation of the OperationCaller object. More... | |
void | setOperationCallerImpl (OperationCallerBasePtr new_impl) |
Sets the internal implementation of the OperationCaller object. More... | |
void | setCaller (ExecutionEngine *caller) |
Sets the caller of this method after the implementation was set. More... | |
void | disconnect () |
Disconnects this caller from the operation it was connected to. More... | |
Protected Member Functions | |
void | setupOperationCaller (OperationInterfacePart *part) |
If no local implementation of an operation could be found, this method tries it using the operationrepository factories. More... | |
A OperationCaller serves as a placeholder (aka 'proxy') for a remote Operation.
If you want to call an operation, you need this class to do it.
The OperationCaller has the exact same signature template argument as the Operation it wishes to call.
OwnThread operations need the caller's ExecutionEngine to be able to inform it of completion . In case the caller has no ExecutionEngine, the GlobalEngine is used instead, and the GlobalEngine will block until the call completes.
Definition at line 82 of file OperationCaller.hpp.
typedef internal::InvokerSignature<boost::function_traits<Signature>::arity, Signature, boost::shared_ptr< base::OperationCallerBase<Signature> > > RTT::OperationCaller< SignatureT >::Base |
Definition at line 94 of file OperationCaller.hpp.
typedef boost::shared_ptr< base::OperationCallerBase<Signature> > RTT::OperationCaller< SignatureT >::OperationCallerBasePtr |
Definition at line 97 of file OperationCaller.hpp.
typedef boost::function_traits<Signature>::result_type RTT::OperationCaller< SignatureT >::result_type |
Definition at line 95 of file OperationCaller.hpp.
typedef SignatureT RTT::OperationCaller< SignatureT >::Signature |
Definition at line 91 of file OperationCaller.hpp.
typedef boost::function_traits<Signature> RTT::OperationCaller< SignatureT >::traits |
Definition at line 96 of file OperationCaller.hpp.
|
inline |
Create an empty OperationCaller object.
Use assignment to initialise it.
Definition at line 103 of file OperationCaller.hpp.
Referenced by RTT::OperationCaller< int(const std::string &)>::operator=().
|
inline |
Create an OperationCaller object with a name and optional caller.
name | The name of the operation that will be called. |
name | The ExecutionEngine of the TaskContext calling the operation. |
Definition at line 112 of file OperationCaller.hpp.
|
inline |
OperationCaller objects may be copied.
A deep copy is made of the implementation object such that using this object does not interfere when using the original, m.
m | the original |
Definition at line 123 of file OperationCaller.hpp.
|
inline |
Initialise a nameless OperationCaller object from a local Operation.
implementation | The implementation of the operation which is to be used by the OperationCaller object. This object will be cloned such that the method uses its own implementation. |
caller | The ExecutionEngine which will be used to call us back in case of asynchronous communication. If zero, the global Engine is used. |
Definition at line 159 of file OperationCaller.hpp.
|
inline |
Initialise a nameless OperationCaller object from an operation factory.
part | The OperationInterfacePart which is used by the OperationCaller object to get the implementation. |
caller | The ExecutionEngine which will be used to call us back in case of asynchronous communication. If zero, the global Engine is used. |
Definition at line 180 of file OperationCaller.hpp.
|
inline |
Initialise a named OperationCaller object from a Service.
name | The name of the operation to look for. |
service | The Service where the operation will be looked up. |
caller | The ExecutionEngine which will be used to call us back in case of asynchronous communication. If zero, the global Engine is used. |
Definition at line 199 of file OperationCaller.hpp.
|
inline |
Clean up the OperationCaller object.
Definition at line 317 of file OperationCaller.hpp.
|
inlinevirtual |
Disconnects this caller from the operation it was connected to.
If this OperationCaller had a name, the name is still kept.
Implements RTT::base::OperationCallerBaseInvoker.
Definition at line 373 of file OperationCaller.hpp.
|
inlinevirtual |
Get the name of this OperationCaller.
Implements RTT::base::OperationCallerBaseInvoker.
Definition at line 333 of file OperationCaller.hpp.
|
inline |
Returns the internal implementation of the OperationCaller object.
Definition at line 356 of file OperationCaller.hpp.
|
inline |
OperationCaller objects may be assigned.
A deep copy is made of the implementation object such that using this object does not interfere when using the original, m.
m | the original |
Definition at line 137 of file OperationCaller.hpp.
|
inline |
OperationCaller objects may be assigned to an implementation.
This variant is used when a local implementation is available.
implementation | the implementation. |
Definition at line 218 of file OperationCaller.hpp.
|
inline |
OperationCaller objects may be assigned to a part responsible for production of an implementation.
This variant is used when a only a remote implementation is available.
part | The part used by the OperationCaller to produce an implementation. |
Definition at line 236 of file OperationCaller.hpp.
|
inline |
Named OperationCaller objects may be looked up in a Service.
service | The Service where the operation will be looked up. |
Definition at line 256 of file OperationCaller.hpp.
|
inlinevirtual |
Check if this OperationCaller is ready for execution.
Implements RTT::base::OperationCallerBaseInvoker.
Definition at line 326 of file OperationCaller.hpp.
Referenced by RTT::OperationCaller< int(const std::string &)>::setImplementation(), and RTT::OperationCaller< int(const std::string &)>::setImplementationPart().
|
inlinevirtual |
Sets the caller of this method after the implementation was set.
caller |
Implements RTT::base::OperationCallerBaseInvoker.
Definition at line 367 of file OperationCaller.hpp.
|
inlinevirtual |
Sets a new implementation for this method.
impl | An implementation object that can be upcast to the OperationCallerBase class type of this method. |
caller | The engine of the calling TaskContext. |
Implements RTT::base::OperationCallerBaseInvoker.
Definition at line 335 of file OperationCaller.hpp.
|
inlinevirtual |
Sets a new implementation for this method by using a service part.
orp | A part obtained from a service's OperationInterface. |
caller | The engine of the calling TaskContext. |
Implements RTT::base::OperationCallerBaseInvoker.
Definition at line 344 of file OperationCaller.hpp.
|
inline |
Sets the internal implementation of the OperationCaller object.
Definition at line 363 of file OperationCaller.hpp.
|
inlineprotected |
If no local implementation of an operation could be found, this method tries it using the operationrepository factories.
part |
Definition at line 383 of file OperationCaller.hpp.
Referenced by RTT::OperationCaller< int(const std::string &)>::OperationCaller().