Orocos Real-Time Toolkit  2.9.0
Public Member Functions | List of all members
RTT::internal::OperationCallerC Class Reference

A template-less manager for OperationCaller calls. More...

#include <rtt/internal/OperationCallerC.hpp>

Public Member Functions

 OperationCallerC ()
 The default constructor. More...
 
 OperationCallerC (OperationInterfacePart *mr, const std::string &name, ExecutionEngine *caller)
 The constructor. More...
 
 OperationCallerC (const OperationCallerC &other)
 A OperationCallerC is copyable by value. More...
 
 OperationCallerC (const OperationCallerC &other, ExecutionEngine *caller)
 A OperationCallerC is copyable by value, with assignment of a new caller. More...
 
OperationCallerCoperator= (const OperationCallerC &other)
 A OperationCallerC is assignable. More...
 
 ~OperationCallerC ()
 
OperationCallerCarg (base::DataSourceBase::shared_ptr a)
 Add a datasource argument to the OperationCaller. More...
 
template<class ArgT >
OperationCallerCargC (const ArgT a)
 Add a constant argument to the OperationCaller. More...
 
template<class ArgT >
OperationCallerCarg (ArgT &a)
 Add an argument by reference to the OperationCaller. More...
 
OperationCallerCret (base::AttributeBase *r)
 Store the result of the method in a task's attribute. More...
 
OperationCallerCret (base::DataSourceBase::shared_ptr r)
 Store the result of the method in a DataSource. More...
 
template<class RetT >
OperationCallerCret (RetT &r)
 Store the result of the method in variable. More...
 
bool call ()
 Call the contained method. More...
 
SendHandleC send ()
 Send the contained method. More...
 
void check ()
 Checks if this method is ready for calling, will throw if not so. More...
 
bool ready () const
 Returns true if this method is ready for execution. More...
 
OperationInterfacePartgetOrp () const
 Returns the factory which we use to produce the operation call. More...
 
std::string const & getName () const
 Returns the name of the operation that will be called. More...
 
base::DataSourceBase::shared_ptr getCallDataSource ()
 Get the contained data source for 'call'. More...
 
base::DataSourceBase::shared_ptr getSendDataSource ()
 Get the contained data source for 'send'. More...
 
base::DataSourceBase::shared_ptr getSendHandleDataSource ()
 Get the contained data source for send handle. More...
 

Detailed Description

A template-less manager for OperationCaller calls.

Definition at line 55 of file OperationCallerC.hpp.

Constructor & Destructor Documentation

RTT::internal::OperationCallerC::OperationCallerC ( )

The default constructor.

Make a copy from another OperationCallerC object in order to make it usable.

Referenced by RTT::OperationCallerC::D::~D().

RTT::internal::OperationCallerC::OperationCallerC ( OperationInterfacePart mr,
const std::string &  name,
ExecutionEngine caller 
)

The constructor.

See also
Service
RTT::internal::OperationCallerC::OperationCallerC ( const OperationCallerC other)

A OperationCallerC is copyable by value.

RTT::internal::OperationCallerC::OperationCallerC ( const OperationCallerC other,
ExecutionEngine caller 
)

A OperationCallerC is copyable by value, with assignment of a new caller.

RTT::internal::OperationCallerC::~OperationCallerC ( )

Member Function Documentation

OperationCallerC& RTT::internal::OperationCallerC::arg ( base::DataSourceBase::shared_ptr  a)

Add a datasource argument to the OperationCaller.

Parameters
aA DataSource which contents are consulted each time when call() is called.

Referenced by RTT_corba_COperationInterface_i::callOperation(), RTT_corba_COperationInterface_i::checkOperation(), and RTT::OperationCallerC::D::~D().

template<class ArgT >
OperationCallerC& RTT::internal::OperationCallerC::arg ( ArgT &  a)
inline

Add an argument by reference to the OperationCaller.

Parameters
aA value of which the reference is used and re-read each time the method is called. Thus if the contents of the source of a changes, call() will use the new contents.

Definition at line 123 of file OperationCallerC.hpp.

template<class ArgT >
OperationCallerC& RTT::internal::OperationCallerC::argC ( const ArgT  a)
inline

Add a constant argument to the OperationCaller.

Parameters
aA value of which a copy is made and this value is used each time in call().

Definition at line 111 of file OperationCallerC.hpp.

bool RTT::internal::OperationCallerC::call ( )
void RTT::internal::OperationCallerC::check ( )
base::DataSourceBase::shared_ptr RTT::internal::OperationCallerC::getCallDataSource ( )

Get the contained data source for 'call'.

Referenced by RTT_corba_COperationInterface_i::callOperation(), and RTT::OperationCallerC::D::~D().

std::string const& RTT::internal::OperationCallerC::getName ( ) const

Returns the name of the operation that will be called.

Referenced by RTT::internal::RemoteOperationCaller< OperationCallerT >::cloneI(), and RTT::OperationCallerC::D::~D().

OperationInterfacePart* RTT::internal::OperationCallerC::getOrp ( ) const

Returns the factory which we use to produce the operation call.

Referenced by RTT::internal::RemoteOperationCaller< OperationCallerT >::cloneI(), and RTT::OperationCallerC::D::~D().

base::DataSourceBase::shared_ptr RTT::internal::OperationCallerC::getSendDataSource ( )

Get the contained data source for 'send'.

Referenced by RTT::OperationCallerC::D::~D().

base::DataSourceBase::shared_ptr RTT::internal::OperationCallerC::getSendHandleDataSource ( )

Get the contained data source for send handle.

OperationCallerC& RTT::internal::OperationCallerC::operator= ( const OperationCallerC other)

A OperationCallerC is assignable.

Referenced by RTT::OperationCallerC::D::~D().

bool RTT::internal::OperationCallerC::ready ( ) const
OperationCallerC& RTT::internal::OperationCallerC::ret ( base::AttributeBase r)

Store the result of the method in a task's attribute.

Parameters
rA task attribute in which the result is stored.

Referenced by RTT::OperationCallerC::D::~D().

OperationCallerC& RTT::internal::OperationCallerC::ret ( base::DataSourceBase::shared_ptr  r)

Store the result of the method in a DataSource.

Parameters
rA data source in which the result is stored.
template<class RetT >
OperationCallerC& RTT::internal::OperationCallerC::ret ( RetT &  r)
inline

Store the result of the method in variable.

Parameters
rA reference to the variable in which the result is stored.

Definition at line 145 of file OperationCallerC.hpp.

SendHandleC RTT::internal::OperationCallerC::send ( )

Send the contained method.

The returned SendHandleC is properly constructed, but still requires the .arg() arguments. The arguments to provide are the ones that collect requires for the sent operation. Once they have been added to the SendHandleC, you can collect() on that object.

Referenced by RTT_corba_COperationInterface_i::callOperation(), RTT::internal::RemoteOperationCallerImpl< OperationCallerT >::send_impl(), and RTT::OperationCallerC::D::~D().


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