RTT::internal::SendHandleC Class Reference

#include <SendHandleC.hpp>

List of all members.

Public Member Functions
template<class ArgT >
SendHandleC &	arg (ArgT &a)
SendHandleC &	arg (base::DataSourceBase::shared_ptr a)
template<class ArgT >
SendHandleC &	arg (ArgT &a)
SendHandleC &	arg (base::DataSourceBase::shared_ptr a)
void	check ()
void	check ()
SendStatus	collect ()
SendStatus	collect ()
SendStatus	collectIfDone ()
SendStatus	collectIfDone ()
OperationInterfacePart *	getOrp ()
OperationInterfacePart *	getOrp ()
base::DataSourceBase::shared_ptr	getSendHandleDataSource ()
base::DataSourceBase::shared_ptr	getSendHandleDataSource ()
SendHandleC &	operator= (const SendHandleC &other)
SendHandleC &	operator= (const SendHandleC &other)
bool	ready () const
bool	ready () const
	SendHandleC (const SendHandleC &other)
	SendHandleC (base::DataSourceBase::shared_ptr operation, base::DataSourceBase::shared_ptr handle, OperationInterfacePart *ofp, const std::string &name)
	SendHandleC ()
	SendHandleC (const SendHandleC &other)
	SendHandleC (base::DataSourceBase::shared_ptr operation, base::DataSourceBase::shared_ptr handle, OperationInterfacePart *ofp, const std::string &name)
	SendHandleC ()
void	setAutoCollect (bool on_off)
void	setAutoCollect (bool on_off)
	~SendHandleC ()
	~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 install/include/rtt/internal/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.

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.

RTT::internal::SendHandleC::SendHandleC

(

const SendHandleC &

other

)

A SendHandleC is copyable by value.

RTT::internal::SendHandleC::~SendHandleC

(

)

RTT::internal::SendHandleC::SendHandleC

(

)

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

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.

RTT::internal::SendHandleC::SendHandleC

(

const SendHandleC &

other

)

A SendHandleC is copyable by value.

RTT::internal::SendHandleC::~SendHandleC

(

)

---

Member Function Documentation

template<class ArgT >

SendHandleC& RTT::internal::SendHandleC::arg

(

ArgT &

a

)

[inline]

Add an argument by reference to the OperationCaller.

Parameters:

a

A 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 rtt/internal/SendHandleC.hpp.

SendHandleC& RTT::internal::SendHandleC::arg

(

base::DataSourceBase::shared_ptr

a

)

Add a datasource argument to the SendHandle.

Parameters:

a

A 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.

Parameters:

a

A 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 install/include/rtt/internal/SendHandleC.hpp.

SendHandleC& RTT::internal::SendHandleC::arg

(

base::DataSourceBase::shared_ptr

a

)

Add a datasource argument to the SendHandle.

Parameters:

a

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

void RTT::internal::SendHandleC::check

(

)

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

Exceptions:

	invalid_handle_exception
	wrong_number_of_args_exception
	wrong_types_of_args_exception

void RTT::internal::SendHandleC::check

(

)

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

Exceptions:

	invalid_handle_exception
	wrong_number_of_args_exception
	wrong_types_of_args_exception

SendStatus RTT::internal::SendHandleC::collect

(

)

Collect the contained method.

SendStatus RTT::internal::SendHandleC::collect

(

)

Collect the contained method.

SendStatus RTT::internal::SendHandleC::collectIfDone

(

)

Collect the contained method.

SendStatus RTT::internal::SendHandleC::collectIfDone

(

)

Collect the contained method.

OperationInterfacePart* RTT::internal::SendHandleC::getOrp

(

)

Get the contained OperationInterfacePart for SendHandle

OperationInterfacePart* RTT::internal::SendHandleC::getOrp

(

)

Get the contained OperationInterfacePart for SendHandle

base::DataSourceBase::shared_ptr RTT::internal::SendHandleC::getSendHandleDataSource

(

)

Get the contained data source for send handle.

base::DataSourceBase::shared_ptr RTT::internal::SendHandleC::getSendHandleDataSource

(

)

Get the contained data source for send handle.

SendHandleC& RTT::internal::SendHandleC::operator=

(

const SendHandleC &

other

)

A SendHandleC is assignable.

SendHandleC& RTT::internal::SendHandleC::operator=

(

const SendHandleC &

other

)

A SendHandleC is assignable.

bool RTT::internal::SendHandleC::ready

(

)

const

Returns true if this handle is ready for execution.

bool RTT::internal::SendHandleC::ready

(

)

const

Returns true if this handle is ready for execution.

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.

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.

---

Member Data Documentation

D * RTT::internal::SendHandleC::d [private]

Definition at line 72 of file install/include/rtt/internal/SendHandleC.hpp.

E * RTT::internal::SendHandleC::e [private]

Definition at line 74 of file install/include/rtt/internal/SendHandleC.hpp.

---

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

• install/include/rtt/internal/SendHandleC.hpp
• rtt/internal/SendHandleC.hpp