RTT::SendHandle< Signature > Class Template Reference

The SendHandle is used to collect the result values of an asynchronous invocation. The template argument Signature must have the same type as the method being invoked. More...

#include <SendHandle.hpp>

List of all members.

Public Types

typedef
internal::CollectSignature
< boost::function_traits
< typename
internal::CollectType
< Signature >::Ft >::arity,
typename internal::CollectType
< Signature >::Ft,
internal::CollectBase
< Signature > * > 
CBase
typedef
internal::CollectSignature
< boost::function_traits
< typename
internal::CollectType
< Signature >::Ft >::arity,
typename internal::CollectType
< Signature >::Ft,
internal::CollectBase
< Signature > * > 
CBase
typedef
internal::ReturnSignature
< boost::function_traits
< Signature >::arity,
Signature, typename
internal::CollectBase
< Signature >::shared_ptr > 
RBase
typedef
internal::ReturnSignature
< boost::function_traits
< Signature >::arity,
Signature, typename
internal::CollectBase
< Signature >::shared_ptr > 
RBase

Public Member Functions

SendStatus collect ()
SendStatus collect ()
 operator bool () const
 operator bool () const
SendHandleoperator= (base::DisposableInterface *implementation)
SendHandleoperator= (base::DisposableInterface *implementation)
bool ready () const
bool ready () const
 SendHandle (const SendHandle &hs)
 SendHandle (typename internal::CollectBase< Signature >::shared_ptr coll)
 SendHandle ()
 SendHandle (const SendHandle &hs)
 SendHandle (typename internal::CollectBase< Signature >::shared_ptr coll)
 SendHandle ()
 ~SendHandle ()
 ~SendHandle ()

Detailed Description

template<class Signature>
class RTT::SendHandle< Signature >

The SendHandle is used to collect the result values of an asynchronous invocation. The template argument Signature must have the same type as the method being invoked.

Definition at line 54 of file install/include/rtt/SendHandle.hpp.


Member Typedef Documentation

template<class Signature>
typedef internal::CollectSignature<boost::function_traits<typename internal::CollectType<Signature>::Ft>::arity, typename internal::CollectType<Signature>::Ft, internal::CollectBase<Signature>* > RTT::SendHandle< Signature >::CBase

Definition at line 51 of file rtt/SendHandle.hpp.

template<class Signature>
typedef internal::CollectSignature<boost::function_traits<typename internal::CollectType<Signature>::Ft>::arity, typename internal::CollectType<Signature>::Ft, internal::CollectBase<Signature>* > RTT::SendHandle< Signature >::CBase

Definition at line 51 of file install/include/rtt/SendHandle.hpp.

template<class Signature>
typedef internal::ReturnSignature<boost::function_traits<Signature>::arity, Signature, typename internal::CollectBase<Signature>::shared_ptr > RTT::SendHandle< Signature >::RBase

Definition at line 54 of file rtt/SendHandle.hpp.

template<class Signature>
typedef internal::ReturnSignature<boost::function_traits<Signature>::arity, Signature, typename internal::CollectBase<Signature>::shared_ptr > RTT::SendHandle< Signature >::RBase

Definition at line 54 of file install/include/rtt/SendHandle.hpp.


Constructor & Destructor Documentation

template<class Signature>
RTT::SendHandle< Signature >::SendHandle (  )  [inline]

Create an empty SendHandle.

Definition at line 58 of file install/include/rtt/SendHandle.hpp.

template<class Signature>
RTT::SendHandle< Signature >::SendHandle ( typename internal::CollectBase< Signature >::shared_ptr  coll  )  [inline]

Definition at line 60 of file install/include/rtt/SendHandle.hpp.

template<class Signature>
RTT::SendHandle< Signature >::SendHandle ( const SendHandle< Signature > &  hs  )  [inline]

Create a copy-equivalent SendHandle.

Definition at line 65 of file install/include/rtt/SendHandle.hpp.

template<class Signature>
RTT::SendHandle< Signature >::~SendHandle (  )  [inline]

No-op destructor, does not change signal/slot state.

Definition at line 70 of file install/include/rtt/SendHandle.hpp.

template<class Signature>
RTT::SendHandle< Signature >::SendHandle (  )  [inline]

Create an empty SendHandle.

Definition at line 58 of file rtt/SendHandle.hpp.

template<class Signature>
RTT::SendHandle< Signature >::SendHandle ( typename internal::CollectBase< Signature >::shared_ptr  coll  )  [inline]

Definition at line 60 of file rtt/SendHandle.hpp.

template<class Signature>
RTT::SendHandle< Signature >::SendHandle ( const SendHandle< Signature > &  hs  )  [inline]

Create a copy-equivalent SendHandle.

Definition at line 65 of file rtt/SendHandle.hpp.

template<class Signature>
RTT::SendHandle< Signature >::~SendHandle (  )  [inline]

No-op destructor, does not change signal/slot state.

Definition at line 70 of file rtt/SendHandle.hpp.


Member Function Documentation

template<class Signature>
SendStatus RTT::SendHandle< Signature >::collect (  )  [inline]

Collect this operator if the method has no arguments.

Definition at line 106 of file rtt/SendHandle.hpp.

template<class Signature>
SendStatus RTT::SendHandle< Signature >::collect (  )  [inline]

Collect this operator if the method has no arguments.

Definition at line 106 of file install/include/rtt/SendHandle.hpp.

template<class Signature>
RTT::SendHandle< Signature >::operator bool (  )  const [inline]

Inspect if this SendHandle is pointing to a valid (existing) invocation.

Returns:
false if no invocation is associated with this SendHandle.

Definition at line 93 of file rtt/SendHandle.hpp.

template<class Signature>
RTT::SendHandle< Signature >::operator bool (  )  const [inline]

Inspect if this SendHandle is pointing to a valid (existing) invocation.

Returns:
false if no invocation is associated with this SendHandle.

Definition at line 93 of file install/include/rtt/SendHandle.hpp.

template<class Signature>
SendHandle& RTT::SendHandle< Signature >::operator= ( base::DisposableInterface implementation  )  [inline]

Definition at line 74 of file rtt/SendHandle.hpp.

template<class Signature>
SendHandle& RTT::SendHandle< Signature >::operator= ( base::DisposableInterface implementation  )  [inline]

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

template<class Signature>
bool RTT::SendHandle< Signature >::ready ( void   )  const [inline]

Inspect if this SendHandle is pointing to valid (existing) invocation.

Returns:
false if no invocation is associated with this handle.

Definition at line 99 of file rtt/SendHandle.hpp.

template<class Signature>
bool RTT::SendHandle< Signature >::ready (  )  const [inline]

Inspect if this SendHandle is pointing to valid (existing) invocation.

Returns:
false if no invocation is associated with this handle.

Definition at line 99 of file install/include/rtt/SendHandle.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:49:49 2013