#include <OperationCallerInterface.hpp>

Inheritance diagram for RTT::base::OperationCallerInterface:

Public Types
typedef boost::shared_ptr < OperationCallerInterface >	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 ()
void	setCaller (ExecutionEngine *ee)
void	setOwner (ExecutionEngine *ee)
bool	setThread (ExecutionThread et, ExecutionEngine *executor)
virtual	~OperationCallerInterface ()
Protected Attributes
ExecutionEngine *	caller
ExecutionThread	met
ExecutionEngine *	myengine

Detailed Description

The interface class for operation callers.

Definition at line 15 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.

Reimplemented from RTT::base::DisposableInterface.

Reimplemented in RTT::internal::LocalOperationCallerImpl< FunctionT >, RTT::base::OperationCallerBase< F >, RTT::base::OperationCallerBase< OperationCallerT >, RTT::base::OperationCallerBase< Signature >, and RTT::base::OperationCallerBase< FunctionT >.

Definition at line 21 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 8 of file OperationCallerInterface.cpp.

OperationCallerInterface::OperationCallerInterface ( OperationCallerInterface const & orig )

Definition at line 12 of file OperationCallerInterface.cpp.

OperationCallerInterface::~OperationCallerInterface ( ) [virtual]

Definition at line 16 of file OperationCallerInterface.cpp.

Member Function Documentation

ExecutionEngine * OperationCallerInterface::getMessageProcessor ( ) const

Definition at line 34 of file OperationCallerInterface.cpp.

ExecutionThread RTT::base::OperationCallerInterface::getThread ( ) const [inline]

Definition at line 67 of file OperationCallerInterface.hpp.

bool RTT::base::OperationCallerInterface::isSend ( ) [inline]

Helpful function to tell us if this operations is to be sent or not.

Definition at line 79 of file 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 >.

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

void OperationCallerInterface::setCaller ( ExecutionEngine * ee )

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

void OperationCallerInterface::setOwner ( ExecutionEngine * ee )

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
	)

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

Member Data Documentation

ExecutionEngine* RTT::base::OperationCallerInterface::caller [protected]

Definition at line 85 of file OperationCallerInterface.hpp.

ExecutionThread RTT::base::OperationCallerInterface::met [protected]

Definition at line 86 of file OperationCallerInterface.hpp.

ExecutionEngine* RTT::base::OperationCallerInterface::myengine [protected]

Definition at line 84 of file OperationCallerInterface.hpp.

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation