RTT::base::OperationCallerBase< F > Struct Template Reference

The base class for all method implementations. More...

#include <rtt/base/OperationCallerBase.hpp>

Inheritance diagram for RTT::base::OperationCallerBase< F >:

List of all members.

Public Types
typedef boost::shared_ptr < OperationCallerBase< F > >	shared_ptr
	Use this type for shared pointer storage of an OperationCallerInterface object.
Public Member Functions
virtual OperationCallerBase< F > *	cloneI (ExecutionEngine *caller) const =0
	Creates a new clone of this method using operator new().
virtual bool	ready () const =0
	Available such that implementations have a way to expose their ready-ness, ie being able to do the call.
void	setOwner (ExecutionEngine *ee)
	Set the ExecutionEngine of the task which owns this method.
void	setExecutor (ExecutionEngine *ee)
	Set an executor which will execute this method when it is called or sent.
void	setCaller (ExecutionEngine *ee)
	Sets the caller's engine of this operation.
bool	setThread (ExecutionThread et, ExecutionEngine *executor)
	Sets the Thread execution policy of this object.
void	reportError ()
	Executed when the operation execution resulted in a C++ exception.
bool	isSend ()
	Helpful function to tell us if this operations is to be sent or not.
virtual void	executeAndDispose ()=0
	Execute functionality and free this object.
virtual void	dispose ()=0
	Just free this object without executing it.
Protected Attributes
ExecutionEngine *	myengine
ExecutionEngine *	caller
ExecutionEngine *	ownerEngine
ExecutionThread	met

---

Detailed Description

template<class F>
struct RTT::base::OperationCallerBase< F >

The base class for all method implementations.

Both local and remote method implementations must inherit from this class.

Definition at line 56 of file OperationCallerBase.hpp.

---

Member Function Documentation

template<class F>

virtual OperationCallerBase<F>* RTT::base::OperationCallerBase< F >::cloneI

(

ExecutionEngine *

caller

)

const [pure virtual]

Creates a new clone of this method using operator new().

Parameters:

caller

The ExecutionEngine of the task that wishes to call this method.

Returns:

a clone.

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 >.

void OperationCallerInterface::reportError

(

)

[inherited]

Executed when the operation execution resulted in a C++ exception.

Must report the error to the ExecutionEngine of the owner of this operation.

Definition at line 47 of file OperationCallerInterface.cpp.

References RTT::ExecutionEngine::setExceptionTask().

Referenced by RTT::internal::FusedMCallDataSource< Signature >::evaluate(), and RTT::internal::LocalOperationCallerImpl< FunctionT >::executeAndDispose().

void OperationCallerInterface::setCaller

(

ExecutionEngine *

ee

)

[inherited]

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.

Definition at line 31 of file OperationCallerInterface.cpp.

void OperationCallerInterface::setExecutor

(

ExecutionEngine *

ee

)

[inherited]

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.

Definition at line 24 of file OperationCallerInterface.cpp.

Referenced by RTT::base::OperationCallerInterface::setThread().

void OperationCallerInterface::setOwner

(

ExecutionEngine *

ee

)

[inherited]

Set the ExecutionEngine of the task which owns this method.

Parameters:

ee	The ExecutionEngine of the component that owns this operation.

Definition at line 20 of file OperationCallerInterface.cpp.

bool OperationCallerInterface::setThread	(	ExecutionThread	et,
		ExecutionEngine *	executor
	)		[inherited]

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.

Definition at line 38 of file OperationCallerInterface.cpp.

References RTT::base::OperationCallerInterface::setExecutor().

Referenced by RTT::Service::setOperationThread().

---

The documentation for this struct was generated from the following file:

• rtt/base/OperationCallerBase.hpp