Classes | Public Member Functions | Private Attributes | List of all members
RTT::internal::SendHandleC Class Reference

#include <SendHandleC.hpp>


class  D
class  E

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


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

RTT::internal::SendHandleC::SendHandleC ( )

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

Definition at line 162 of file SendHandleC.cpp.

RTT::internal::SendHandleC::SendHandleC ( base::DataSourceBase::shared_ptr  operation,
base::DataSourceBase::shared_ptr  handle,
OperationInterfacePart ofp,
const std::string &  name 

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

Definition at line 167 of file SendHandleC.cpp.

RTT::internal::SendHandleC::SendHandleC ( const SendHandleC other)

A SendHandleC is copyable by value.

Definition at line 180 of file SendHandleC.cpp.

RTT::internal::SendHandleC::~SendHandleC ( )

Definition at line 199 of file SendHandleC.cpp.

Member Function Documentation

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

Add a datasource argument to the SendHandle.

aA DataSource which contents are filled in in case of collect() or collectIfDone()

Definition at line 205 of file SendHandleC.cpp.

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

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.

void RTT::internal::SendHandleC::check ( )

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


Definition at line 271 of file SendHandleC.cpp.

SendStatus RTT::internal::SendHandleC::collect ( )

Collect the contained method.

Definition at line 223 of file SendHandleC.cpp.

SendStatus RTT::internal::SendHandleC::collectIfDone ( )

Collect the contained method.

Definition at line 241 of file SendHandleC.cpp.

OperationInterfacePart * RTT::internal::SendHandleC::getOrp ( )

Get the contained OperationInterfacePart for SendHandle

Definition at line 284 of file SendHandleC.cpp.

DataSourceBase::shared_ptr RTT::internal::SendHandleC::getSendHandleDataSource ( )

Get the contained data source for send handle.

Definition at line 282 of file SendHandleC.cpp.

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

A SendHandleC is assignable.

Definition at line 185 of file SendHandleC.cpp.

bool RTT::internal::SendHandleC::ready ( ) const

Returns true if this handle is ready for execution.

Definition at line 261 of file SendHandleC.cpp.

void RTT::internal::SendHandleC::setAutoCollect ( bool  on_off)

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.

Definition at line 266 of file SendHandleC.cpp.

Member Data Documentation

D* RTT::internal::SendHandleC::d

Definition at line 72 of file SendHandleC.hpp.

E* RTT::internal::SendHandleC::e

Definition at line 74 of file SendHandleC.hpp.

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

Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:47