$search

RTT::base::OperationCallerInterface Struct Reference

#include <OperationCallerInterface.hpp>

Inheritance diagram for RTT::base::OperationCallerInterface:
Inheritance graph
[legend]

List of all members.

Public Types

typedef boost::shared_ptr
< OperationCallerInterface
shared_ptr

Public Member Functions

bool isSend ()
 OperationCallerInterface (OperationCallerInterface const &orig)
 OperationCallerInterface ()
virtual bool ready () const =0
void reportError ()
void setCaller (ExecutionEngine *ee)
void setExecutor (ExecutionEngine *ee)
void setOwner (ExecutionEngine *ee)
bool setThread (ExecutionThread et, ExecutionEngine *executor)
virtual ~OperationCallerInterface ()

Protected Attributes

ExecutionEnginecaller
ExecutionThread met
ExecutionEnginemyengine
ExecutionEngineownerEngine

Detailed Description

The interface class for operation callers.

Definition at line 15 of file OperationCallerInterface.hpp.


Member Typedef Documentation


Constructor & Destructor Documentation

OperationCallerInterface::OperationCallerInterface (  ) 

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

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

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

Definition at line 82 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 47 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 31 of file OperationCallerInterface.cpp.

void OperationCallerInterface::setExecutor ( ExecutionEngine ee  ) 

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.

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


Member Data Documentation

Definition at line 85 of file OperationCallerInterface.hpp.

Definition at line 87 of file OperationCallerInterface.hpp.

Definition at line 84 of file OperationCallerInterface.hpp.

Definition at line 86 of file OperationCallerInterface.hpp.


The documentation for this struct was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rtt
Author(s): RTT Developers
autogenerated on Fri Mar 1 16:27:42 2013