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< Treal, Tmatrix >::MatrixBase(), and mat::MatrixBase< Treal, Tmatrix >::operator=().

template<typename Tobj>

bool mat::ValidPtr< Tobj >::haveDataStructureGet

(

)

const [inline]

Referenced by mat::VectorGeneral< ergo_real, Vectorrr >::is_empty(), mat::MatrixBase< Treal, Tmatrix >::is_empty(), mat::MatrixBase< Treal, Tmatrix >::MatrixBase(), mat::VectorGeneral< ergo_real, Vectorrr >::operator=(), mat::MatrixBase< Treal, Tmatrix >::operator=(), mat::ValidPtr< Vectorrr >::swap(), and mat::VectorGeneral< ergo_real, Vectorrr >::VectorGeneral().

template<typename Tobj>

void mat::ValidPtr< Tobj >::haveDataStructureSet

(

bool

val

)

[inline]

Referenced by mat::VectorGeneral< ergo_real, Vectorrr >::clear_structure(), mat::MatrixTriangular< Treal, Tmatrix >::inch(), mat::MatrixBase< Treal, Tmatrix >::MatrixBase(), mat::VectorGeneral< ergo_real, Vectorrr >::operator=(), mat::MatrixBase< Treal, Tmatrix >::operator=(), mat::VectorGeneral< ergo_real, Vectorrr >::resetSizesAndBlocks(), mat::MatrixBase< Treal, Tmatrix >::resetSizesAndBlocks(), and mat::VectorGeneral< ergo_real, Vectorrr >::VectorGeneral().

template<typename Tobj>

bool mat::ValidPtr< Tobj >::inMemoryGet

(

)

const [inline]

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

template<typename Tobj>

void mat::ValidPtr< Tobj >::inMemorySet

(

bool

val

)

[inline]

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

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]

Access to ptr forbidden if haveDataStructure is false.

Referenced by mat::ValidPtr< Vectorrr >::haveDataStructureGet(), mat::ValidPtr< Vectorrr >::haveDataStructureSet(), mat::ValidPtr< Vectorrr >::operator*(), and mat::ValidPtr< Vectorrr >::operator->().

template<typename Tobj>

bool mat::ValidPtr< Tobj >::inMemory [protected]

Access to ptr forbidden if inMemory is false.

Referenced by mat::ValidPtr< Vectorrr >::inMemoryGet(), mat::ValidPtr< Vectorrr >::inMemorySet(), mat::ValidPtr< Vectorrr >::operator*(), and mat::ValidPtr< Vectorrr >::operator->().

template<typename Tobj>

Tobj* mat::ValidPtr< Tobj >::ptr [protected]

Referenced by mat::ValidPtr< Vectorrr >::getConstRefForCopying(), mat::ValidPtr< Vectorrr >::operator*(), mat::ValidPtr< Vectorrr >::operator->(), mat::ValidPtr< Vectorrr >::swap(), and mat::ValidPtr< Vectorrr >::~ValidPtr().

---

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

• source/matrix/ValidPtr.h