axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIteratorHelper Class Reference

A virtual base class to help with iteration of an OctreeLevel's blocks. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/spin/OctreeLevel.hpp>

Public Member Functions
virtual	~BlockIteratorHelper ()
	Virtual destructor. More...
virtual void	increment ()=0
	A function to increment to the next Block in the level. More...
virtual bool	equal (const BlockIteratorHelper *other)=0
	Predicate to determine if two BlockIteratorHelpers are equivalent. More...
virtual GridPt	pt () const =0
	Accessor for the point associated with the current octree block. More...
virtual BlockDataType *	data ()=0
	Accessor for the data associated with the current octree block. More...
virtual const BlockDataType *	data () const =0
	Const accessor for the data associated with the current octree block. More...

Detailed Description

template<int DIM, typename BlockDataType>
class axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIteratorHelper

A virtual base class to help with iteration of an OctreeLevel's blocks.

Constructor & Destructor Documentation

~BlockIteratorHelper()

template<int DIM, typename BlockDataType >

virtual axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIteratorHelper::~BlockIteratorHelper ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

increment()

template<int DIM, typename BlockDataType >

virtual void axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIteratorHelper::increment ( )

pure virtual

A function to increment to the next Block in the level.

equal()

template<int DIM, typename BlockDataType >

virtual bool axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIteratorHelper::equal ( const BlockIteratorHelper *  other )

pure virtual

Predicate to determine if two BlockIteratorHelpers are equivalent.

pt()

template<int DIM, typename BlockDataType >

virtual GridPt axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIteratorHelper::pt ( ) const

pure virtual

Accessor for the point associated with the current octree block.

data() [1/2]

template<int DIM, typename BlockDataType >

virtual BlockDataType* axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIteratorHelper::data ( )

pure virtual

Accessor for the data associated with the current octree block.

data() [2/2]

template<int DIM, typename BlockDataType >

virtual const BlockDataType* axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIteratorHelper::data ( ) const

pure virtual

Const accessor for the data associated with the current octree block.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/spin/OctreeLevel.hpp