Gambit::safe_ptr< TYPE > Class Template Reference

A safe pointer that throws an informative error if you try to dereference it when nullified, and cannot be used to overwrite the thing it points to. More...

#include <util_types.hpp>

Inheritance diagram for Gambit::safe_ptr< TYPE >:

Public Member Functions
	safe_ptr (TYPE *in_ptr=NULL)
	Construct-o-safe_ptr. More...
virtual void	set (TYPE *in_ptr)
	Set pointer. More...
virtual const TYPE &	operator* () const
	Dereference pointer. More...
virtual const TYPE &	operator[] (int index) const
	Dereference pointer as if it is an array. More...
virtual const TYPE *	operator-> () const
	Access is allowed to const member functions only. More...

Static Protected Member Functions
static void	dieGracefully ()
	Failure message invoked when the user tries to dereference a null safe_ptr. More...

Protected Attributes
const TYPE *	ptr
	The actual underlying pointer, interpreted as a pointer to constant value. More...

Detailed Description

template<typename TYPE>
class Gambit::safe_ptr< TYPE >

A safe pointer that throws an informative error if you try to dereference it when nullified, and cannot be used to overwrite the thing it points to.

Definition at line 175 of file util_types.hpp.

Constructor & Destructor Documentation

safe_ptr()

template<typename TYPE>

Gambit::safe_ptr< TYPE >::safe_ptr ( TYPE *  in_ptr = NULL )

inline

Construct-o-safe_ptr.

Definition at line 181 of file util_types.hpp.

{ ptr = in_ptr; }

Member Function Documentation

dieGracefully()

template<typename TYPE>

static void Gambit::safe_ptr< TYPE >::dieGracefully ( )

inlinestaticprotected

Failure message invoked when the user tries to dereference a null safe_ptr.

Definition at line 213 of file util_types.hpp.

Referenced by Gambit::omp_safe_ptr< TYPE >::operator*().

      {
        str errmsg = "You just tried to dereference a GAMBIT safe pointer that has value";
        errmsg +=  "\nNULL.  Bad idea.  Probably you tried to retrieve a conditional"
                   "\ndependency that has not been activated because the necessary condition"
                   "\nhas not been met, or you tried to access a model parameter for a model"
                   "\nthat you are not actually scanning.  This means there is a bug in one"
                   "\nof your module functions.";
        utils_error().raise(LOCAL_INFO,errmsg);
      }

Here is the caller graph for this function:

operator*()

template<typename TYPE>

virtual const TYPE& Gambit::safe_ptr< TYPE >::operator* ( ) const

inlinevirtual

Dereference pointer.

Reimplemented in Gambit::omp_safe_ptr< TYPE >.

Definition at line 187 of file util_types.hpp.

      {
        if (ptr == NULL) dieGracefully();
        return *ptr;
      }

operator->()

template<typename TYPE>

virtual const TYPE* Gambit::safe_ptr< TYPE >::operator-> ( ) const

inlinevirtual

Access is allowed to const member functions only.

Definition at line 201 of file util_types.hpp.

      {
        if (ptr == NULL) dieGracefully();
        return ptr;
      }

operator[]()

template<typename TYPE>

virtual const TYPE& Gambit::safe_ptr< TYPE >::operator[] ( int  index ) const

inlinevirtual

Dereference pointer as if it is an array.

Definition at line 194 of file util_types.hpp.

      {
        if (ptr == NULL) dieGracefully();
        return *(ptr+index);
      }

set()

template<typename TYPE>

virtual void Gambit::safe_ptr< TYPE >::set ( TYPE *  in_ptr )

inlinevirtual

Set pointer.

Definition at line 184 of file util_types.hpp.

{ ptr = in_ptr; }

Member Data Documentation

ptr

template<typename TYPE>

const TYPE* Gambit::safe_ptr< TYPE >::ptr

protected

The actual underlying pointer, interpreted as a pointer to constant value.

Definition at line 210 of file util_types.hpp.

---

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

• Utils/include/gambit/Utils/util_types.hpp