Public Member Functions | Private Attributes
RTT::internal::OperationCallerC Class Reference

#include <OperationCallerC.hpp>

List of all members.

Public Member Functions

OperationCallerCarg (base::DataSourceBase::shared_ptr a)
template<class ArgT >
OperationCallerCarg (ArgT &a)
template<class ArgT >
OperationCallerCargC (const ArgT a)
bool call ()
void check ()
base::DataSourceBase::shared_ptr getCallDataSource ()
std::string const & getName () const
OperationInterfacePartgetOrp () const
base::DataSourceBase::shared_ptr getSendDataSource ()
base::DataSourceBase::shared_ptr getSendHandleDataSource ()
 OperationCallerC ()
 OperationCallerC (OperationInterfacePart *mr, const std::string &name, ExecutionEngine *caller)
 OperationCallerC (const OperationCallerC &other)
OperationCallerCoperator= (const OperationCallerC &other)
bool ready () const
OperationCallerCret (base::AttributeBase *r)
OperationCallerCret (base::DataSourceBase::shared_ptr r)
template<class RetT >
OperationCallerCret (RetT &r)
SendHandleC send ()
 ~OperationCallerC ()

Private Attributes

D * d
base::DataSourceBase::shared_ptr m
std::string mname
OperationInterfacePartofp
base::DataSourceBase::shared_ptr s

Detailed Description

A template-less manager for OperationCaller calls.

Definition at line 55 of file OperationCallerC.hpp.


Constructor & Destructor Documentation

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

The constructor.

See also:
Service

A OperationCallerC is copyable by value.


Member Function Documentation

Add a datasource argument to the OperationCaller.

Parameters:
aA DataSource which contents are consulted each time when call() is called.
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 118 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 106 of file OperationCallerC.hpp.

Call the contained method.

Checks if this method is ready for calling, will throw if not so. Otherwise, does nothing.

Exceptions:
name_not_found_exception
wrong_number_of_args_exception
wrong_types_of_args_exception

Get the contained data source for 'call'.

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

Returns the name of the operation that will be called.

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

Get the contained data source for 'send'.

Get the contained data source for send handle.

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

A OperationCallerC is assignable.

Returns true if this method is ready for execution.

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

Parameters:
rA task attribute in which the result is stored.

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 140 of file OperationCallerC.hpp.

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.


Member Data Documentation

Definition at line 60 of file OperationCallerC.hpp.

Definition at line 62 of file OperationCallerC.hpp.

Definition at line 65 of file OperationCallerC.hpp.

Definition at line 64 of file OperationCallerC.hpp.

Definition at line 63 of file OperationCallerC.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Wed Aug 26 2015 16:16:24