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

#include <SendHandleC.hpp>

List of all members.

Public Member Functions

SendHandleCarg (base::DataSourceBase::shared_ptr a)
template<class ArgT >
SendHandleCarg (ArgT &a)
void check ()
SendStatus collect ()
SendStatus collectIfDone ()
OperationInterfacePartgetOrp ()
base::DataSourceBase::shared_ptr getSendHandleDataSource ()
SendHandleCoperator= (const SendHandleC &other)
bool ready () const
 SendHandleC ()
 SendHandleC (base::DataSourceBase::shared_ptr operation, base::DataSourceBase::shared_ptr handle, OperationInterfacePart *ofp, const std::string &name)
 SendHandleC (const SendHandleC &other)
void setAutoCollect (bool on_off)
 ~SendHandleC ()

Private Attributes

D * d
E * e

Detailed Description

A template-less SendHandle manager. It is created using a SendHandle data source, obtained from a OperationFactoryPart::produceSend(), the part itself and any arguments that must be provided to collect the results.

It is used by OperationCallerC to pass on responsibility to collect results to a separate object.

Definition at line 61 of file SendHandleC.hpp.

Constructor & Destructor Documentation

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

The constructor from a SendHandle data source and an operation part. The SendHandle is obtained after a send.

A SendHandleC is copyable by value.

Member Function Documentation

Add a datasource argument to the SendHandle.

aA DataSource which contents are filled in in case of collect() or collectIfDone()
template<class ArgT >
SendHandleC& RTT::internal::SendHandleC::arg ( ArgT &  a) [inline]

Add an argument by reference to the OperationCaller.

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 115 of file SendHandleC.hpp.

Checks if this handle is ready for collecting, will throw if not so. Otherwise, does nothing.


Collect the contained method.

Collect the contained method.

Get the contained OperationInterfacePart for SendHandle

Get the contained data source for send handle.

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

A SendHandleC is assignable.

Returns true if this handle is ready for execution.

When set to 'on', the destruction of this SendHandleC will cause a call to collect() before all data in data sources is destroyed. This is required for in-process operation calls, since destruction of the data sources would lead to memory corruption of the operation's arguments. When set to 'off', no such collection is done, which is useful in remote/inter-process communication, in which the data lives in a copy in the other process anyway. Since RTT uses this same class for both situations, we need a flag to distinguish.

Defaults to 'on', which is the safe default if unspecified.

Member Data Documentation

Definition at line 72 of file SendHandleC.hpp.

Definition at line 74 of file SendHandleC.hpp.

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

Author(s): RTT Developers
autogenerated on Sat Jun 8 2019 18:46:39