axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresentationType >::IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType > Class Template Reference

Concrete instance of the BlockIteratorHelper class defined in the OctreeLevel base class. More...

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

Inherits ParentType.

Public Types
using	self = IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType >
using	BaseBlockItType = ParentType

Public Member Functions
	IteratorHelper (OctreeLevelType *octLevel, bool begin)
void	increment ()
	Increment to next block in the level. More...
GridPt	pt () const
	Accessor for point associated with iterator's block. More...
BlockDataType *	data ()
	Accessor for data associated with the iterator's block. More...
const BlockDataType *	data () const
	Const accessor for data associated with the iterator's block. More...
bool	equal (const BaseBlockItType *other)
	Predicate to determine if two block iterators are the same. More...

Detailed Description

template<int DIM, typename BlockDataType, typename PointRepresentationType>
template<typename OctreeLevelType, typename AdaptedIterType, typename ParentType>
class axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresentationType >::IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType >

Concrete instance of the BlockIteratorHelper class defined in the OctreeLevel base class.

Member Typedef Documentation

self

template<int DIM, typename BlockDataType , typename PointRepresentationType >

template<typename OctreeLevelType , typename AdaptedIterType , typename ParentType >

using axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresentationType >::IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType >::self = IteratorHelper<OctreeLevelType, AdaptedIterType, ParentType>

BaseBlockItType

template<int DIM, typename BlockDataType , typename PointRepresentationType >

template<typename OctreeLevelType , typename AdaptedIterType , typename ParentType >

using axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresentationType >::IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType >::BaseBlockItType = ParentType

Constructor & Destructor Documentation

IteratorHelper()

template<int DIM, typename BlockDataType , typename PointRepresentationType >

template<typename OctreeLevelType , typename AdaptedIterType , typename ParentType >

axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresentationType >::IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType >::IteratorHelper ( OctreeLevelType *  octLevel, bool  begin  )

inline

Member Function Documentation

increment()

template<int DIM, typename BlockDataType , typename PointRepresentationType >

template<typename OctreeLevelType , typename AdaptedIterType , typename ParentType >

void axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresentationType >::IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType >::increment ( )

inline

Increment to next block in the level.

References axom::spin::OctreeLevel< DIM, BlockDataType >::BROOD_SIZE.

pt()

template<int DIM, typename BlockDataType , typename PointRepresentationType >

template<typename OctreeLevelType , typename AdaptedIterType , typename ParentType >

GridPt axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresentationType >::IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType >::pt ( ) const

inline

Accessor for point associated with iterator's block.

data() [1/2]

template<int DIM, typename BlockDataType , typename PointRepresentationType >

template<typename OctreeLevelType , typename AdaptedIterType , typename ParentType >

BlockDataType* axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresentationType >::IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType >::data ( )

inline

Accessor for data associated with the iterator's block.

data() [2/2]

template<int DIM, typename BlockDataType , typename PointRepresentationType >

template<typename OctreeLevelType , typename AdaptedIterType , typename ParentType >

const BlockDataType* axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresentationType >::IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType >::data ( ) const

inline

Const accessor for data associated with the iterator's block.

equal()

template<int DIM, typename BlockDataType , typename PointRepresentationType >

template<typename OctreeLevelType , typename AdaptedIterType , typename ParentType >

bool axom::spin::SparseOctreeLevel< DIM, BlockDataType, PointRepresentationType >::IteratorHelper< OctreeLevelType, AdaptedIterType, ParentType >::equal ( const BaseBlockItType *  other )

inline

Predicate to determine if two block iterators are the same.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/spin/SparseOctreeLevel.hpp