Dune::Fem::ObjectPointer< ReferenceCounter > Class Template Reference

models a pointer to a reference countable object More...

#include <dune/fem/storage/referencecounter.hh>

Public Types
typedef ReferenceCounter	ReferenceCounterType
	type of the object, this pointer points to
typedef ReferenceCounterType::ObjectType	ObjectType

Public Member Functions
	ObjectPointer (ReferenceCounterType *const object=0)
	initialize a pointer (with a standard C++ pointer)
	ObjectPointer (const ThisType &other)
	copy constructor
	~ObjectPointer ()
	destructor
ThisType &	operator= (const ThisType &other)
	assign another pointer to this one.
ObjectType &	operator* () const
	dereference the ObjectPointer
unsigned int	referenceCounter () const
	return current reference count

Protected Attributes
ReferenceCounterType *	object_

Detailed Description

template<class ReferenceCounter>
class Dune::Fem::ObjectPointer< ReferenceCounter >

models a pointer to a reference countable object

ObjectPointer tries to behave like a normal pointer to an object implementing the ReferenceCounterInterface. Internally, however, it calls the object's addReference and removeReference methods whenever the pointer is created, assign or deleted.

Member Typedef Documentation

ObjectType

template<class ReferenceCounter >

typedef ReferenceCounterType::ObjectType Dune::Fem::ObjectPointer< ReferenceCounter >::ObjectType

ReferenceCounterType

template<class ReferenceCounter >

typedef ReferenceCounter Dune::Fem::ObjectPointer< ReferenceCounter >::ReferenceCounterType

type of the object, this pointer points to

Constructor & Destructor Documentation

ObjectPointer() [1/2]

template<class ReferenceCounter >

Dune::Fem::ObjectPointer< ReferenceCounter >::ObjectPointer ( ReferenceCounterType *const  object = 0 )

inlineexplicit

initialize a pointer (with a standard C++ pointer)

Parameters

[in]

object

C++ pointer to initialize this pointer with; the default value is 0

ObjectPointer() [2/2]

template<class ReferenceCounter >

Dune::Fem::ObjectPointer< ReferenceCounter >::ObjectPointer ( const ThisType &  other )

inline

copy constructor

Copying an ObjectPointer will also increase the reference counter of the object pointed to.

Parameters

[in]

other

pointer to assign to this one

~ObjectPointer()

template<class ReferenceCounter >

Dune::Fem::ObjectPointer< ReferenceCounter >::~ObjectPointer ( )

inline

destructor

When the pointer is deleted, the reference counter of the object pointed to is automatically decreased.

Member Function Documentation

operator*()

template<class ReferenceCounter >

ObjectType & Dune::Fem::ObjectPointer< ReferenceCounter >::operator* ( ) const

inline

dereference the ObjectPointer

Note

This method asserts that the pointer is not 0.

Returns

a reference to the object pointed to.

operator=()

template<class ReferenceCounter >

ThisType & Dune::Fem::ObjectPointer< ReferenceCounter >::operator= ( const ThisType &  other )

inline

assign another pointer to this one.

referenceCounter()

template<class ReferenceCounter >

unsigned int Dune::Fem::ObjectPointer< ReferenceCounter >::referenceCounter ( ) const

inline

return current reference count

Member Data Documentation

object_

template<class ReferenceCounter >

ReferenceCounterType* Dune::Fem::ObjectPointer< ReferenceCounter >::object_

protected

---

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

• referencecounter.hh