HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe > Class Template Referenceabstract

This base class for ValueAccessors manages registration of an accessor with a tree so that the tree can automatically clear the accessor whenever one of its nodes is deleted. More...

#include <ValueAccessor.h>

Public Member Functions

 ValueAccessorBase (TreeType &tree)
 Construct from a tree. Should rarely be invoked directly, the drived implementation class calls this. Remains public for backwards compatibility. More...
 
virtual ~ValueAccessorBase ()
 
 ValueAccessorBase (const ValueAccessorBase &other)
 Copy constructor - if IsSafe, then the copy also registers itself against the tree it is accessing. More...
 
ValueAccessorBaseoperator= (const ValueAccessorBase &other)
 
TreeType * getTree () const
 Return a pointer to the tree associated with this accessor. More...
 
TreeType & tree () const
 Return a reference to the tree associated with this accessor. More...
 
virtual void clear ()=0
 Pure virtual method, clears the derived accessor. More...
 

Static Public Member Functions

static constexpr bool isSafe ()
 Return true if this accessor is safe, i.e. registered by the tree from which it is constructed. Un-registered accessors can in rare cases be faster because it avoids the (small) overhead of registration, but they are unsafe if the tree is modified. So unless you're an expert it is highly recommended to set IsSafe = true (which is the default). More...
 

Static Public Attributes

static constexpr bool IsConstTree = std::is_const<TreeType>::value
 Returns true if this accessor is operating on a const tree type. More...
 

Protected Member Functions

virtual void release ()
 

Protected Attributes

TreeType * mTree
 

Friends

template<typename >
class Tree
 

Detailed Description

template<typename TreeType, bool IsSafe>
class openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe >

This base class for ValueAccessors manages registration of an accessor with a tree so that the tree can automatically clear the accessor whenever one of its nodes is deleted.

Definition at line 151 of file ValueAccessor.h.

Constructor & Destructor Documentation

template<typename TreeType, bool IsSafe>
openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe >::ValueAccessorBase ( TreeType &  tree)
inline

Construct from a tree. Should rarely be invoked directly, the drived implementation class calls this. Remains public for backwards compatibility.

Definition at line 168 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe>
virtual openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe >::~ValueAccessorBase ( )
inlinevirtual

Definition at line 174 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe>
openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe >::ValueAccessorBase ( const ValueAccessorBase< TreeType, IsSafe > &  other)
inline

Copy constructor - if IsSafe, then the copy also registers itself against the tree it is accessing.

Definition at line 178 of file ValueAccessor.h.

Member Function Documentation

template<typename TreeType, bool IsSafe>
TreeType* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe >::getTree ( ) const
inline

Return a pointer to the tree associated with this accessor.

The pointer will be null only if the tree from which this accessor was constructed was subsequently deleted (which generally leaves the accessor in an unsafe state).

Definition at line 198 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe>
static constexpr bool openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe >::isSafe ( )
inlinestatic

Return true if this accessor is safe, i.e. registered by the tree from which it is constructed. Un-registered accessors can in rare cases be faster because it avoids the (small) overhead of registration, but they are unsafe if the tree is modified. So unless you're an expert it is highly recommended to set IsSafe = true (which is the default).

Definition at line 163 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe>
ValueAccessorBase& openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe >::operator= ( const ValueAccessorBase< TreeType, IsSafe > &  other)
inline

Definition at line 184 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe>
TreeType& openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe >::tree ( ) const
inline

Return a reference to the tree associated with this accessor.

Definition at line 201 of file ValueAccessor.h.

Friends And Related Function Documentation

template<typename TreeType, bool IsSafe>
template<typename >
friend class Tree
friend

Definition at line 208 of file ValueAccessor.h.

Member Data Documentation

template<typename TreeType, bool IsSafe>
constexpr bool openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe >::IsConstTree = std::is_const<TreeType>::value
static

Returns true if this accessor is operating on a const tree type.

Definition at line 155 of file ValueAccessor.h.

template<typename TreeType, bool IsSafe>
TreeType* openvdb::OPENVDB_VERSION_NAME::tree::ValueAccessorBase< TreeType, IsSafe >::mTree
protected

Definition at line 210 of file ValueAccessor.h.


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