ergo
mat::ValidPtr< Tobj > Class Template Reference

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

#include <ValidPtr.h>

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

◆ ValidPtr() [1/2]

template<typename Tobj>
mat::ValidPtr< Tobj >::ValidPtr ( Tobj * p)
inlineexplicit

Copy ordinary pointer constructor.

References haveDataStructure, inMemory, and ptr.

Referenced by operator=(), and swap().

◆ ~ValidPtr()

template<typename Tobj>
mat::ValidPtr< Tobj >::~ValidPtr ( )
inline

References ptr.

◆ ValidPtr() [2/2]

template<typename Tobj>
mat::ValidPtr< Tobj >::ValidPtr ( ValidPtr< Tobj > const & )
inlineprivate

Member Function Documentation

◆ getConstRefForCopying()

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.

References ptr.

Referenced by mat::MatrixBase< Treal, Tmatrix >::MatrixBase(), and mat::MatrixBase< Treal, Tmatrix >::operator=().

◆ haveDataStructureGet()

◆ haveDataStructureSet()

template<typename Tobj>
void mat::ValidPtr< Tobj >::haveDataStructureSet ( bool val)
inline

References haveDataStructure.

◆ inMemoryGet()

template<typename Tobj>
bool mat::ValidPtr< Tobj >::inMemoryGet ( ) const
inline

◆ inMemorySet()

template<typename Tobj>
void mat::ValidPtr< Tobj >::inMemorySet ( bool val)
inline

References inMemory.

◆ operator*()

template<typename Tobj>
Tobj & mat::ValidPtr< Tobj >::operator* ( ) const
inline

References haveDataStructure, inMemory, and ptr.

◆ operator->()

template<typename Tobj>
Tobj * mat::ValidPtr< Tobj >::operator-> ( ) const
inline

References haveDataStructure, inMemory, and ptr.

◆ operator=()

template<typename Tobj>
ValidPtr< Tobj > & mat::ValidPtr< Tobj >::operator= ( ValidPtr< Tobj > const & )
inlineprivate

References ValidPtr().

◆ swap()

template<typename Tobj>
static void mat::ValidPtr< Tobj >::swap ( ValidPtr< Tobj > & ptrA,
ValidPtr< Tobj > & ptrB )
inlinestatic

Member Data Documentation

◆ haveDataStructure

template<typename Tobj>
bool mat::ValidPtr< Tobj >::haveDataStructure
protected

Access to ptr forbidden if haveDataStructure is false.

Referenced by haveDataStructureGet(), haveDataStructureSet(), operator*(), operator->(), and ValidPtr().

◆ inMemory

template<typename Tobj>
bool mat::ValidPtr< Tobj >::inMemory
protected

Access to ptr forbidden if inMemory is false.

Referenced by inMemoryGet(), inMemorySet(), operator*(), operator->(), and ValidPtr().

◆ ptr

template<typename Tobj>
Tobj* mat::ValidPtr< Tobj >::ptr
protected

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