OpenVDB  1.2.0
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
ValueAccessorBase< TreeType > 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>

Inherited by ValueAccessor< TreeType >, and ValueAccessor< TreeType, TreeType::DEPTH-1, tbb::spin_mutex >.

Public Member Functions

 ValueAccessorBase (TreeType &tree)
 
virtual ~ValueAccessorBase ()
 
TreeType * getTree () const
 
TreeType & tree () const
 
 ValueAccessorBase (const ValueAccessorBase &other)
 
ValueAccessorBaseoperator= (const ValueAccessorBase &other)
 
virtual void clear ()=0
 

Static Public Attributes

static const bool IsConstTree = boost::is_const<TreeType>::value
 

Protected Member Functions

virtual void release ()
 

Protected Attributes

TreeType * mTree
 

Friends

template<typename >
class Tree
 

Detailed Description

template<typename TreeType>
class openvdb::v1_2_0::tree::ValueAccessorBase< TreeType >

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.

Constructor & Destructor Documentation

ValueAccessorBase ( TreeType &  tree)
inline
virtual ~ValueAccessorBase ( )
inlinevirtual
ValueAccessorBase ( const ValueAccessorBase< TreeType > &  other)
inline

Member Function Documentation

virtual void clear ( )
pure virtual
TreeType* getTree ( ) const
inline
Returns
a pointer to the tree associated by this ValueAccessor
Note
The only circumstance under which the return value can be NULL is if the tree from which the ValueAccessor is constructed was subsequently deleted - which generally leaves the ValueAccessor in an unsafe state!
ValueAccessorBase& operator= ( const ValueAccessorBase< TreeType > &  other)
inline
virtual void release ( )
inlineprotectedvirtual
TreeType& tree ( ) const
inline
Returns
a reference to the tree associated by this ValueAccessor

Friends And Related Function Documentation

friend class Tree
friend

Member Data Documentation

const bool IsConstTree = boost::is_const<TreeType>::value
static
TreeType* mTree
protected

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