#include <OperationCallerInterface.hpp>

Inheritance diagram for RTT::base::OperationCallerInterface:

[legend]

Public Types
typedef boost::shared_ptr< OperationCallerInterface >	shared_ptr

Public Types inherited from RTT::base::DisposableInterface
typedef boost::shared_ptr< DisposableInterface >	shared_ptr

Public Member Functions
ExecutionEngine *	getMessageProcessor () const

ExecutionThread	getThread () const

bool	isSend ()

	OperationCallerInterface ()

	OperationCallerInterface (OperationCallerInterface const &orig)

virtual bool	ready () const =0

void	reportError ()

virtual void	setCaller (ExecutionEngine *ee)

virtual void	setOwner (ExecutionEngine *ee)

bool	setThread (ExecutionThread et, ExecutionEngine *executor)

virtual	~OperationCallerInterface ()

Public Member Functions inherited from RTT::base::DisposableInterface
virtual void	dispose ()=0

virtual void	executeAndDispose ()=0

virtual	~DisposableInterface ()

Protected Attributes
ExecutionEngine *	caller

ExecutionThread	met

ExecutionEngine *	myengine

Detailed Description

The interface class for operation callers.

Definition at line 53 of file OperationCallerInterface.hpp.

Member Typedef Documentation

typedef boost::shared_ptr<OperationCallerInterface> RTT::base::OperationCallerInterface::shared_ptr

Use this type for shared pointer storage of an OperationCallerInterface object.

Definition at line 59 of file OperationCallerInterface.hpp.

Constructor & Destructor Documentation

OperationCallerInterface::OperationCallerInterface ( )

Initializes an empty OperationCallerInterface with owner, executor and caller set to zero and the ExecutionThread type to ClientThread.

Definition at line 46 of file OperationCallerInterface.cpp.

OperationCallerInterface::OperationCallerInterface ( OperationCallerInterface const & orig )

Definition at line 50 of file OperationCallerInterface.cpp.

OperationCallerInterface::~OperationCallerInterface ( )

virtual

Definition at line 54 of file OperationCallerInterface.cpp.

Member Function Documentation

ExecutionEngine * OperationCallerInterface::getMessageProcessor ( ) const

Definition at line 80 of file OperationCallerInterface.cpp.

ExecutionThread RTT::base::OperationCallerInterface::getThread ( ) const

inline

Definition at line 105 of file OperationCallerInterface.hpp.

bool OperationCallerInterface::isSend ( )

Helpful function to tell us if this operations is to be sent or not. Sending is only required if the operation is OwnThread and in a different thread than the caller.

Definition at line 72 of file OperationCallerInterface.cpp.

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

void OperationCallerInterface::reportError ( )

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 90 of file OperationCallerInterface.cpp.

void OperationCallerInterface::setCaller ( ExecutionEngine * ee )

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.

Definition at line 62 of file OperationCallerInterface.cpp.

void OperationCallerInterface::setOwner ( ExecutionEngine * ee )

virtual

Set the ExecutionEngine of the task which owns this method.

Parameters

ee	The ExecutionEngine of the component that owns this operation.

Definition at line 58 of file OperationCallerInterface.cpp.

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

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.