vrtree_cpp::HTypeR

Reference counted wrapper around a handle. Automatically closes the handle when there are no references left. More...

#include <interface_helpers.hpp>

Public Functions

Type	Name
void	dec() Manually decrement the refcount. If recount hits zero, handle is closed.
	HTypeR() Construct a null handle.
	HTypeR(T handle) Construct from a raw node handle and make it refcounted.
	HTypeR(const HTypeR< T > & other) Copy an existing handle, incrementing its refcount.
void	inc() Manually increment the refcount (effectively makes the handle permanent until manually closed)
	operator T() const Access the raw node handle.
bool	operator<(T other) const Compare the raw node handle for storage in ordered containers.
HTypeR< T > &	operator=(const HTypeR< T > & other) Assign an existing handle.
HTypeR< T > &	operator=(T handle) Assign a raw handle and make it refcounted.
	~HTypeR() Decrements refcount, closing the node handle if this is the last reference.
T *	raw(const HTypeR< T > arr[]) Converts an array of reference counted handles to an array of raw handles for passing to an api function that expects an array of handles. Return value is only valid until the next call to this function.

Public Attributes

Type	Name
T	m_handle The handle to wrap.
HRefCount *	ptr Reference counter. Automatically deletes itself when the refcount is zero.

Detailed Description

template <typename T >
struct vrtree_cpp::HTypeR;

Reference counted wrapper around a handle. Automatically closes the handle when there are no references left.

Public Functions Documentation

dec

inline void dec()

Manually decrement the refcount. If recount hits zero, handle is closed.

HTypeR

inline HTypeR()

Construct a null handle.

HTypeR

inline HTypeR(
    T handle
)

Construct from a raw node handle and make it refcounted.

HTypeR

inline HTypeR(
    const HTypeR< T > & other
)

Copy an existing handle, incrementing its refcount.

inc

inline void inc()

Manually increment the refcount (effectively makes the handle permanent until manually closed)

operator T

inline operator T() const

Access the raw node handle.

operator<

inline bool operator<(
    T other
) const

Compare the raw node handle for storage in ordered containers.

operator=

inline HTypeR< T > & operator=(
    const HTypeR< T > & other
)

Assign an existing handle.

operator=

inline HTypeR< T > & operator=(
    T handle
)

Assign a raw handle and make it refcounted.

~HTypeR

inline ~HTypeR()

Decrements refcount, closing the node handle if this is the last reference.

raw

static inline T * raw(
    const HTypeR< T > arr[]
)

Converts an array of reference counted handles to an array of raw handles for passing to an api function that expects an array of handles. Return value is only valid until the next call to this function.

Public Attributes Documentation

m_handle

T m_handle;

The handle to wrap.

ptr

HRefCount * ptr;

Reference counter. Automatically deletes itself when the refcount is zero.