mat::ValidPtr< Tobj > Class Template Reference

Smart pointer class to control access to object. More...

#include <ValidPtr.h>

List of all members.

Public Member Functions

 ValidPtr (Tobj *p)
 Copy ordinary pointer constructor.
 ~ValidPtr ()
Tobj & operator* () const
Tobj * operator-> () const
const Tobj & getConstRefForCopying () const
 getConstRefForCopying() is provided to make it possible to copy the object also when it is written to file.
void inMemorySet (bool val)
bool inMemoryGet () const
void haveDataStructureSet (bool val)
bool haveDataStructureGet () const

Static Public Member Functions

static void swap (ValidPtr< Tobj > &ptrA, ValidPtr< Tobj > &ptrB)

Protected Attributes

Tobj * ptr
bool inMemory
 Access to ptr forbidden if inMemory is false.
bool haveDataStructure
 Access to ptr forbidden if haveDataStructure is false.

Private Member Functions

 ValidPtr (ValidPtr< Tobj > const &)
ValidPtr< Tobj > & operator= (ValidPtr< Tobj > const &)

Detailed Description

template<typename Tobj>
class mat::ValidPtr< Tobj >

Smart pointer class to control access to object.

Primary use: Control access to objects that may be written to file.


Constructor & Destructor Documentation

template<typename Tobj>
mat::ValidPtr< Tobj >::ValidPtr ( Tobj *  p  )  [inline, explicit]

Copy ordinary pointer constructor.

template<typename Tobj>
mat::ValidPtr< Tobj >::~ValidPtr (  )  [inline]
template<typename Tobj>
mat::ValidPtr< Tobj >::ValidPtr ( ValidPtr< Tobj > const &   )  [inline, private]

Member Function Documentation

template<typename Tobj>
const Tobj& mat::ValidPtr< Tobj >::getConstRefForCopying (  )  const [inline]

getConstRefForCopying() is provided to make it possible to copy the object also when it is written to file.

Referenced by mat::MatrixBase< ergo_real, Matri >::MatrixBase(), and mat::MatrixBase< ergo_real, Matri >::operator=().

template<typename Tobj>
bool mat::ValidPtr< Tobj >::haveDataStructureGet (  )  const [inline]
template<typename Tobj>
void mat::ValidPtr< Tobj >::haveDataStructureSet ( bool  val  )  [inline]
template<typename Tobj>
bool mat::ValidPtr< Tobj >::inMemoryGet (  )  const [inline]
template<typename Tobj>
void mat::ValidPtr< Tobj >::inMemorySet ( bool  val  )  [inline]
template<typename Tobj>
Tobj& mat::ValidPtr< Tobj >::operator* (  )  const [inline]
template<typename Tobj>
Tobj* mat::ValidPtr< Tobj >::operator-> (  )  const [inline]
template<typename Tobj>
ValidPtr<Tobj>& mat::ValidPtr< Tobj >::operator= ( ValidPtr< Tobj > const &   )  [inline, private]
template<typename Tobj>
static void mat::ValidPtr< Tobj >::swap ( ValidPtr< Tobj > &  ptrA,
ValidPtr< Tobj > &  ptrB 
) [inline, static]

Member Data Documentation

template<typename Tobj>
bool mat::ValidPtr< Tobj >::haveDataStructure [protected]
template<typename Tobj>
bool mat::ValidPtr< Tobj >::inMemory [protected]
template<typename Tobj>
Tobj* mat::ValidPtr< Tobj >::ptr [protected]

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

Generated on 21 Nov 2012 for ergo by  doxygen 1.6.1