Orocos Real-Time Toolkit  2.9.0
Public Member Functions | List of all members
RTT::base::OperationCallerBaseInvoker Struct Referenceabstract

An invoker can be given an implementation and is identified by a name. More...

#include <rtt/base/OperationCallerBaseInvoker.hpp>

Inheritance diagram for RTT::base::OperationCallerBaseInvoker:
RTT::OperationCaller< bool(const std::string &)> RTT::OperationCaller< bool(const std::string &, const std::string &)> RTT::OperationCaller< bool(const std::string &code)> RTT::OperationCaller< bool(const std::string &filename)> RTT::OperationCaller< bool(const std::string &name, const std::string &filename)> RTT::OperationCaller< int(const std::string &)> RTT::OperationCaller< RTT::scripting::ProgramInterface::Status::RTT::scripting::ProgramInterface::Status(const std::string &)> RTT::OperationCaller< RTT::scripting::StateMachine::Status::RTT::scripting::StateMachine::Status(const std::string &)> RTT::OperationCaller< std::string(const std::string &)> RTT::corba::OperationCallerProxy RTT::OperationCaller< SignatureT >

Public Member Functions

virtual ~OperationCallerBaseInvoker ()
 
virtual bool ready () const =0
 Returns true if this OperationCaller has received a correct implementation. More...
 
virtual void disconnect ()=0
 Disconnects this caller from the operation it was connected to. More...
 
virtual bool setImplementation (boost::shared_ptr< base::DisposableInterface > impl, ExecutionEngine *caller=0)=0
 Sets a new implementation for this method. More...
 
virtual bool setImplementationPart (OperationInterfacePart *orp, ExecutionEngine *caller=0)=0
 Sets a new implementation for this method by using a service part. More...
 
virtual void setCaller (ExecutionEngine *caller)=0
 Sets the caller of this method after the implementation was set. More...
 
virtual const std::string & getName () const =0
 Returns the name of this method instance. More...
 

Detailed Description

An invoker can be given an implementation and is identified by a name.

Definition at line 52 of file OperationCallerBaseInvoker.hpp.

Constructor & Destructor Documentation

virtual RTT::base::OperationCallerBaseInvoker::~OperationCallerBaseInvoker ( )
inlinevirtual

Definition at line 54 of file OperationCallerBaseInvoker.hpp.

References disconnect(), getName(), ready(), setCaller(), setImplementation(), and setImplementationPart().

Member Function Documentation

virtual void RTT::base::OperationCallerBaseInvoker::disconnect ( )
pure virtual

Disconnects this caller from the operation it was connected to.

If this OperationCaller had a name, the name is still kept.

Postcondition
this->ready() == false

Implemented in RTT::OperationCaller< SignatureT >, RTT::OperationCaller< std::string(const std::string &)>, RTT::OperationCaller< bool(const std::string &code)>, RTT::OperationCaller< bool(const std::string &filename)>, RTT::OperationCaller< RTT::scripting::StateMachine::Status::RTT::scripting::StateMachine::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &name, const std::string &filename)>, RTT::OperationCaller< RTT::scripting::ProgramInterface::Status::RTT::scripting::ProgramInterface::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &, const std::string &)>, RTT::OperationCaller< bool(const std::string &)>, RTT::OperationCaller< int(const std::string &)>, and RTT::corba::OperationCallerProxy.

Referenced by RTT::ServiceRequester::disconnect(), and ~OperationCallerBaseInvoker().

virtual const std::string& RTT::base::OperationCallerBaseInvoker::getName ( ) const
pure virtual

Returns the name of this method instance.

Implemented in RTT::OperationCaller< SignatureT >, RTT::OperationCaller< std::string(const std::string &)>, RTT::OperationCaller< bool(const std::string &code)>, RTT::OperationCaller< bool(const std::string &filename)>, RTT::OperationCaller< RTT::scripting::StateMachine::Status::RTT::scripting::StateMachine::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &name, const std::string &filename)>, RTT::OperationCaller< RTT::scripting::ProgramInterface::Status::RTT::scripting::ProgramInterface::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &, const std::string &)>, RTT::OperationCaller< bool(const std::string &)>, RTT::OperationCaller< int(const std::string &)>, and RTT::corba::OperationCallerProxy.

Referenced by RTT::ServiceRequester::addOperationCaller(), and ~OperationCallerBaseInvoker().

virtual bool RTT::base::OperationCallerBaseInvoker::ready ( ) const
pure virtual

Returns true if this OperationCaller has received a correct implementation.

Implemented in RTT::OperationCaller< SignatureT >, RTT::OperationCaller< std::string(const std::string &)>, RTT::OperationCaller< bool(const std::string &code)>, RTT::OperationCaller< bool(const std::string &filename)>, RTT::OperationCaller< RTT::scripting::StateMachine::Status::RTT::scripting::StateMachine::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &name, const std::string &filename)>, RTT::OperationCaller< RTT::scripting::ProgramInterface::Status::RTT::scripting::ProgramInterface::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &, const std::string &)>, RTT::OperationCaller< bool(const std::string &)>, RTT::OperationCaller< int(const std::string &)>, and RTT::corba::OperationCallerProxy.

Referenced by ~OperationCallerBaseInvoker().

virtual void RTT::base::OperationCallerBaseInvoker::setCaller ( ExecutionEngine *  caller)
pure virtual

Sets the caller of this method after the implementation was set.

Parameters
caller

Implemented in RTT::OperationCaller< SignatureT >, RTT::OperationCaller< std::string(const std::string &)>, RTT::OperationCaller< bool(const std::string &code)>, RTT::OperationCaller< bool(const std::string &filename)>, RTT::OperationCaller< RTT::scripting::StateMachine::Status::RTT::scripting::StateMachine::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &name, const std::string &filename)>, RTT::OperationCaller< RTT::scripting::ProgramInterface::Status::RTT::scripting::ProgramInterface::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &, const std::string &)>, RTT::OperationCaller< bool(const std::string &)>, RTT::OperationCaller< int(const std::string &)>, and RTT::corba::OperationCallerProxy.

Referenced by ~OperationCallerBaseInvoker().

virtual bool RTT::base::OperationCallerBaseInvoker::setImplementation ( boost::shared_ptr< base::DisposableInterface >  impl,
ExecutionEngine *  caller = 0 
)
pure virtual

Sets a new implementation for this method.

Parameters
implAn implementation object that can be upcast to the OperationCallerBase class type of this method.
callerThe engine of the calling TaskContext.
Returns
true if the impl could be upcast to a matching OperationCallerBase type, false otherwise.

Implemented in RTT::OperationCaller< SignatureT >, RTT::OperationCaller< std::string(const std::string &)>, RTT::OperationCaller< bool(const std::string &code)>, RTT::OperationCaller< bool(const std::string &filename)>, RTT::OperationCaller< RTT::scripting::StateMachine::Status::RTT::scripting::StateMachine::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &name, const std::string &filename)>, RTT::OperationCaller< RTT::scripting::ProgramInterface::Status::RTT::scripting::ProgramInterface::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &, const std::string &)>, RTT::OperationCaller< bool(const std::string &)>, RTT::OperationCaller< int(const std::string &)>, and RTT::corba::OperationCallerProxy.

Referenced by ~OperationCallerBaseInvoker().

virtual bool RTT::base::OperationCallerBaseInvoker::setImplementationPart ( OperationInterfacePart *  orp,
ExecutionEngine *  caller = 0 
)
pure virtual

Sets a new implementation for this method by using a service part.

Parameters
orpA part obtained from a service's OperationInterface.
callerThe engine of the calling TaskContext.
Returns
true if the part could produce the correct OperationCallerBase type, false otherwise.

Implemented in RTT::OperationCaller< SignatureT >, RTT::OperationCaller< std::string(const std::string &)>, RTT::OperationCaller< bool(const std::string &code)>, RTT::OperationCaller< bool(const std::string &filename)>, RTT::OperationCaller< RTT::scripting::StateMachine::Status::RTT::scripting::StateMachine::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &name, const std::string &filename)>, RTT::OperationCaller< RTT::scripting::ProgramInterface::Status::RTT::scripting::ProgramInterface::Status(const std::string &)>, RTT::OperationCaller< bool(const std::string &, const std::string &)>, RTT::OperationCaller< bool(const std::string &)>, RTT::OperationCaller< int(const std::string &)>, and RTT::corba::OperationCallerProxy.

Referenced by ~OperationCallerBaseInvoker().

The documentation for this struct was generated from the following file:
Generated on Fri Apr 5 2019 11:59:43 for Orocos Real-Time Toolkit by   doxygen 1.8.11