OpenFPM_data  0.1.0
Project that contain the implementation and interfaces for basic structure like vectors, grids, graph ... .
 All Data Structures Namespaces Functions Variables Typedefs Friends
encapc< dim, T, Mem > Class Template Reference

this structure encapsulate an object of the grid More...

Detailed Description

template<unsigned int dim, typename T, typename Mem>
class encapc< dim, T, Mem >

this structure encapsulate an object of the grid

This structure encapsulate an object of the grid It give the possibility to select the property in a secondary moment

Parameters
dimDimensionality of the grid
Ttype of object the grid store
Memsuppose to be a boost::fusion::vector of arrays

Definition at line 209 of file Encap.hpp.

#include <Encap.hpp>

Public Types

typedef T::type type
 
typedef int yes_i_am_encap
 
typedef T T_type
 

Public Member Functions

 encapc (type &data_c)
 
type * operator& ()
 Return the address of the base. More...
 
template<unsigned int p>
type_cpu_prop< p, Mem >::type get ()
 access the data More...
 
template<unsigned int p>
const type_cpu_prop< p, Mem >::type get () const
 access the data but return a constant reference More...
 
template<unsigned int p>
void set (typename type_cpu_prop< p, Mem >::type &ele)
 
encapc< dim, T, Mem > & operator= (const encapc< dim, T, Mem > &ec)
 Assignment. More...
 
encapc< dim, T, Mem > & operator= (const T &obj)
 Assignment. More...
 
bool operator== (const encapc< dim, T, Mem > &ec) const
 Compare. More...
 
bool operator!= (const encapc< dim, T, Mem > &ec) const
 Compare. More...
 

Static Public Attributes

static const int max_prop = T::max_prop
 

Private Attributes

type & data_c
 

Member Function Documentation

template<unsigned int dim, typename T, typename Mem>
template<unsigned int p>
type_cpu_prop<p,Mem>::type encapc< dim, T, Mem >::get ( )
inline

access the data

Returns
the reference

Definition at line 246 of file Encap.hpp.

template<unsigned int dim, typename T, typename Mem>
template<unsigned int p>
const type_cpu_prop<p,Mem>::type encapc< dim, T, Mem >::get ( ) const
inline

access the data but return a constant reference

Returns
the reference

Definition at line 259 of file Encap.hpp.

template<unsigned int dim, typename T, typename Mem>
bool encapc< dim, T, Mem >::operator!= ( const encapc< dim, T, Mem > &  ec) const
inline

Compare.

Parameters
ecencapsulator
Returns
true if the two encap store different information

Definition at line 327 of file Encap.hpp.

template<unsigned int dim, typename T, typename Mem>
type* encapc< dim, T, Mem >::operator& ( )
inline

Return the address of the base.

Returns
the address of the data encapsulated

Definition at line 236 of file Encap.hpp.

template<unsigned int dim, typename T, typename Mem>
encapc<dim,T,Mem>& encapc< dim, T, Mem >::operator= ( const encapc< dim, T, Mem > &  ec)
inline

Assignment.

Parameters
ecencapsulator

Definition at line 281 of file Encap.hpp.

template<unsigned int dim, typename T, typename Mem>
encapc<dim,T,Mem>& encapc< dim, T, Mem >::operator= ( const T &  obj)
inline

Assignment.

Parameters
ecencapsulator

Definition at line 295 of file Encap.hpp.

template<unsigned int dim, typename T, typename Mem>
bool encapc< dim, T, Mem >::operator== ( const encapc< dim, T, Mem > &  ec) const
inline

Compare.

Parameters
ecencapsulator
Returns
true if the two encap store the same information

Definition at line 311 of file Encap.hpp.


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