class Gambit::safe_variable_ptr #

[No description available] More…

#include <util_types.hpp>

Public Functions #

Protected Functions #

Protected Attributes #

Detailed Description #

template <typename TYPE >
class Gambit::safe_variable_ptr;

A safe variable pointer that throws an informative error if you try to dereference it when nullified, but unlike safe_ptr it can be used to overwrite the thing it points to. However, it is not possible to change the address of this pointer without using the ‘set’ function (in which case you presumably know what you’re doing).

Public Functions Documentation #

function operator= #

safe_variable_ptr & operator=(
    const safe_variable_ptr & 
) =delete

Remove the default copy constructor and assignment operator.

function safe_variable_ptr #

safe_variable_ptr(
    const safe_variable_ptr & 
) =delete

function safe_variable_ptr #

inline safe_variable_ptr(
    TYPE * in_ptr =NULL
)

Constructor.

function set #

inline void set(
    TYPE * in_ptr
)

Set pointer.

function get #

inline TYPE * get()

Get pointer.

function operator* #

inline TYPE & operator*()

Dereference pointer.

function operator[] #

inline TYPE & operator[](
    int index
)

Dereference pointer as if it is an array.

function operator-> #

inline TYPE * operator->()

Access member functions.

Protected Functions Documentation #

function dieGracefully #

static inline void dieGracefully()

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

Protected Attributes Documentation #

variable ptr #

TYPE * ptr;

The actual underlying pointer.

Updated on 2023-06-26 at 21:36:51 +0000