SAGA Adaptor CPI v.1.0
saga::adaptors::instance_data< T > Class Template Reference

#include <instance_data.hpp>

Inheritance diagram for saga::adaptors::instance_data< T >:

List of all members.

Public Types

typedef T instance_data_type

Public Member Functions

 instance_data (proxy *prxy)
template<typename Cpi >
 instance_data (Cpi *cpi_instance)
 instance_data ()
template<typename Cpi >
void init_data (Cpi *proxy, TR1::shared_ptr< instance_data_type > d)
template<typename Cpi >
void release_data (Cpi *proxy)
 ~instance_data (void)
T * operator-> () const

Detailed Description

template<typename T>
class saga::adaptors::instance_data< T >

Class implementing the scoped_lock pattern for the instance_data

Note:
If you want to use shared data which had been registered in the instance_data instance in the session, just create an instance of this class at the beginning of the scope you will use the shared data in by specifying its id.

Definition at line 49 of file instance_data.hpp.


Member Typedef Documentation

template<typename T >
typedef T saga::adaptors::instance_data< T >::instance_data_type

Definition at line 60 of file instance_data.hpp.


Constructor & Destructor Documentation

template<typename T >
saga::adaptors::instance_data< T >::instance_data ( proxy *  prxy) [inline]

Constructor: Here we lock the appropriate object identified by id

Parameters:
idthe identifier for the object you want to lock.
Note:
The object you want to lock has to be registered in the current session before.

Definition at line 69 of file instance_data.hpp.

template<typename T >
template<typename Cpi >
saga::adaptors::instance_data< T >::instance_data ( Cpi *  cpi_instance) [inline]

Definition at line 77 of file instance_data.hpp.

template<typename T >
saga::adaptors::instance_data< T >::instance_data ( ) [inline]

Definition at line 85 of file instance_data.hpp.

template<typename T >
saga::adaptors::instance_data< T >::~instance_data ( void  ) [inline]

Destructor: unlocks the object.

Definition at line 112 of file instance_data.hpp.


Member Function Documentation

template<typename T >
template<typename Cpi >
void saga::adaptors::instance_data< T >::init_data ( Cpi *  proxy,
TR1::shared_ptr< instance_data_type d 
) [inline]

Definition at line 93 of file instance_data.hpp.

template<typename T >
template<typename Cpi >
void saga::adaptors::instance_data< T >::release_data ( Cpi *  proxy) [inline]

Definition at line 103 of file instance_data.hpp.

template<typename T >
T* saga::adaptors::instance_data< T >::operator-> ( ) const [inline]

Definition at line 119 of file instance_data.hpp.


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