Public Member Functions | Private Attributes
coil::Async_t< Object, Func > Class Template Reference

Async_t template class. More...

#include <Async.h>

Inheritance diagram for coil::Async_t< Object, Func >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Async_t (Object *obj, Func func, bool auto_delete=false)
 Constructor.
virtual void finalize ()
 Finalize the asynchronous function.
virtual bool finished ()
 Check on completion state.
virtual void invoke ()
 Asynchronous function Activation.
virtual int svc ()
 Thread execution function for asynchronous invoke.
virtual ~Async_t ()
 Destructor.

Private Attributes

const bool m_autodelete
bool m_finished
Func m_func
Mutex m_mutex
Object * m_obj

Detailed Description

template<typename Object, typename Func>
class coil::Async_t< Object, Func >

Async_t template class.

Definition at line 132 of file Async.h.


Constructor & Destructor Documentation

template<typename Object, typename Func>
coil::Async_t< Object, Func >::Async_t ( Object *  obj,
Func  func,
bool  auto_delete = false 
) [inline]

Constructor.

Constructor

Parameters:
objThe target object for the asynchronous function.
funcAsynchronous function.
auto_deleteflag for automatic instance destruction.

Definition at line 160 of file Async.h.

template<typename Object, typename Func>
virtual coil::Async_t< Object, Func >::~Async_t ( ) [inline, virtual]

Destructor.

Destructor

Definition at line 180 of file Async.h.


Member Function Documentation

template<typename Object, typename Func>
virtual void coil::Async_t< Object, Func >::finalize ( ) [inline, virtual]

Finalize the asynchronous function.

Finalize the asynchronous function for preparing it for destruction.

Reimplemented from coil::Task.

Definition at line 229 of file Async.h.

template<typename Object, typename Func>
virtual bool coil::Async_t< Object, Func >::finished ( ) [inline, virtual]

Check on completion state.

Return a completion state.

Returns:
true: finished, false: unfinished

Implements coil::Async.

Definition at line 274 of file Async.h.

template<typename Object, typename Func>
virtual void coil::Async_t< Object, Func >::invoke ( ) [inline, virtual]

Asynchronous function Activation.

Activate of Asynchronous function.

Implements coil::Async.

Definition at line 250 of file Async.h.

template<typename Object, typename Func>
virtual int coil::Async_t< Object, Func >::svc ( void  ) [inline, virtual]

Thread execution function for asynchronous invoke.

Invoke the registered objects operation.

Returns:
The execution result.

Reimplemented from coil::Task.

Definition at line 203 of file Async.h.


Member Data Documentation

template<typename Object, typename Func>
const bool coil::Async_t< Object, Func >::m_autodelete [private]

Definition at line 283 of file Async.h.

template<typename Object, typename Func>
bool coil::Async_t< Object, Func >::m_finished [private]

Definition at line 282 of file Async.h.

template<typename Object, typename Func>
Func coil::Async_t< Object, Func >::m_func [private]

Definition at line 281 of file Async.h.

template<typename Object, typename Func>
Mutex coil::Async_t< Object, Func >::m_mutex [private]

Definition at line 284 of file Async.h.

template<typename Object, typename Func>
Object* coil::Async_t< Object, Func >::m_obj [private]

Definition at line 280 of file Async.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Thu Aug 27 2015 14:16:40