dune-grid  2.4
Public Types | Public Member Functions | Protected Member Functions | List of all members
Dune::EntitySeed< GridImp, EntitySeedImp > Class Template Reference

Store a reference to an entity with a minimal memory footprint. More...

#include <dune/grid/common/entityseed.hh>

Public Types

enum  { codimension = EntitySeedImp::codimension }
 codimension of underlying entity More...
 
typedef EntitySeedImp Implementation
 Export the implementation type. More...
 

Public Member Functions

 EntitySeed ()
 Construct an empty (i.e. isValid() == false) seed. More...
 
 EntitySeed (const EntitySeedImp &implementation)
 Construct from implementation class. More...
 
bool isValid () const
 check whether it is safe to create an Entity from this Seed More...
 

Protected Member Functions

Implementation & impl ()
 Access to the actual implementation. More...
 
const Implementation & impl () const
 const Access to the actual implementation More...
 

Detailed Description

template<class GridImp, class EntitySeedImp>
class Dune::EntitySeed< GridImp, EntitySeedImp >

Store a reference to an entity with a minimal memory footprint.

The EntitySeed provides a light-weight way to store an entity. It is supposed to be implemented as memory-efficiently as possible. To get back the actual entity (or, rather, EntityPointer), you need the corresponding grid. On the grid, there is the method entityPointer(const EntitySeed&), which gives you an EntityPointer in exchange for an EntitySeed.

Member Typedef Documentation

template<class GridImp , class EntitySeedImp >
typedef EntitySeedImp Dune::EntitySeed< GridImp, EntitySeedImp >::Implementation

Export the implementation type.

Member Enumeration Documentation

template<class GridImp , class EntitySeedImp >
anonymous enum

codimension of underlying entity

Enumerator
codimension 

Constructor & Destructor Documentation

template<class GridImp , class EntitySeedImp >
Dune::EntitySeed< GridImp, EntitySeedImp >::EntitySeed ( )
inline

Construct an empty (i.e. isValid() == false) seed.

template<class GridImp , class EntitySeedImp >
Dune::EntitySeed< GridImp, EntitySeedImp >::EntitySeed ( const EntitySeedImp &  implementation)
inline

Construct from implementation class.

Member Function Documentation

template<class GridImp , class EntitySeedImp >
Implementation& Dune::EntitySeed< GridImp, EntitySeedImp >::impl ( )
inlineprotected

Access to the actual implementation.

template<class GridImp , class EntitySeedImp >
const Implementation& Dune::EntitySeed< GridImp, EntitySeedImp >::impl ( ) const
inlineprotected

const Access to the actual implementation

template<class GridImp , class EntitySeedImp >
bool Dune::EntitySeed< GridImp, EntitySeedImp >::isValid ( ) const
inline

check whether it is safe to create an Entity from this Seed


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