pcl::octree::OctreeBreadthFirstIterator< OctreeT > Class Template Reference
[Module octree]

Octree iterator class More...

#include <pcl/octree/octree_iterator.h>

Inheritance diagram for pcl::octree::OctreeBreadthFirstIterator< OctreeT >:

[legend]

Collaboration diagram for pcl::octree::OctreeBreadthFirstIterator< OctreeT >:

[legend]

List of all members.

Public Member Functions
	OctreeBreadthFirstIterator (unsigned int max_depth_arg=0)
	Empty constructor.
	OctreeBreadthFirstIterator (OctreeT *octree_arg, unsigned int max_depth_arg=0)
	Constructor.
virtual	~OctreeBreadthFirstIterator ()
	Empty deconstructor.
OctreeBreadthFirstIterator &	operator= (const OctreeBreadthFirstIterator &src)
	Copy operator.
void	reset ()
	Reset the iterator to the root node of the octree.
OctreeBreadthFirstIterator &	operator++ ()
	Preincrement operator.
OctreeBreadthFirstIterator	operator++ (int)
	postincrement operator.
Protected Attributes
std::deque< IteratorState >	FIFO_
	FIFO list.

---

Detailed Description

template<typename OctreeT>
class pcl::octree::OctreeBreadthFirstIterator< OctreeT >

Octree iterator class

Note:

This class implements a forward iterator for traversing octrees in a breadth-first manner.

Author:

Julius Kammerl (julius@kammerl.de)

Definition at line 454 of file octree_iterator.h.

---

Constructor & Destructor Documentation

template<typename OctreeT >

pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator

(

unsigned int

max_depth_arg = 0

)

[inline, explicit]

Empty constructor.

Parameters:

[in]

max_depth_arg

Depth limitation during traversal

Definition at line 185 of file octree_iterator.hpp.

References pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().

template<typename OctreeT >

pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator	(	OctreeT *	octree_arg,
		unsigned int	max_depth_arg = 0
	)			[inline, explicit]

Constructor.

Parameters:

[in]	octree_arg	Octree to be iterated. Initially the iterator is set to its root node.
[in]	max_depth_arg	Depth limitation during traversal

Definition at line 196 of file octree_iterator.hpp.

References pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().

template<typename OctreeT >

pcl::octree::OctreeBreadthFirstIterator< OctreeT >::~OctreeBreadthFirstIterator

(

)

[inline, virtual]

Empty deconstructor.

Definition at line 207 of file octree_iterator.hpp.

---

Member Function Documentation

template<typename OctreeT >

OctreeBreadthFirstIterator pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++

(

int

)

[inline]

postincrement operator.

Note:

step to next octree node

Definition at line 516 of file octree_iterator.h.

template<typename OctreeT >

OctreeBreadthFirstIterator< OctreeT > & pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++

(

)

[inline]

Preincrement operator.

Note:

step to next octree node

Definition at line 237 of file octree_iterator.hpp.

References pcl::octree::BRANCH_NODE, pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::depth_, pcl::octree::OctreeBreadthFirstIterator< OctreeT >::FIFO_, pcl::octree::OctreeNode::getNodeType(), pcl::octree::IteratorState::key_, pcl::octree::OctreeIteratorBase< OctreeT >::max_octree_depth_, pcl::octree::IteratorState::node_, pcl::octree::OctreeIteratorBase< OctreeT >::octree_, pcl::octree::OctreeKey::popBranch(), and pcl::octree::OctreeKey::pushBranch().

template<typename OctreeT >

OctreeBreadthFirstIterator& pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator=

(

const OctreeBreadthFirstIterator< OctreeT > &

src

)

[inline]

Copy operator.

Parameters:

[in]

src

the iterator to copy into this

Reimplemented from pcl::octree::OctreeIteratorBase< OctreeT >.

Definition at line 483 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, and pcl::octree::OctreeBreadthFirstIterator< OctreeT >::FIFO_.

template<typename OctreeT >

void pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset

(

)

[inline]

Reset the iterator to the root node of the octree.

Reimplemented from pcl::octree::OctreeIteratorBase< OctreeT >.

Definition at line 213 of file octree_iterator.hpp.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::depth_, pcl::octree::OctreeBreadthFirstIterator< OctreeT >::FIFO_, pcl::octree::IteratorState::key_, pcl::octree::IteratorState::node_, pcl::octree::OctreeIteratorBase< OctreeT >::octree_, pcl::octree::OctreeKey::x, pcl::octree::OctreeKey::y, and pcl::octree::OctreeKey::z.

Referenced by pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator().

---

Member Data Documentation

template<typename OctreeT >

std::deque<IteratorState> pcl::octree::OctreeBreadthFirstIterator< OctreeT >::FIFO_ [protected]

FIFO list.

Definition at line 525 of file octree_iterator.h.

Referenced by pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator=(), and pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().

---

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

• /builddir/build/BUILD/pcl-pcl-1.7.1/octree/include/pcl/octree/octree_iterator.h
• /builddir/build/BUILD/pcl-pcl-1.7.1/octree/include/pcl/octree/impl/octree_iterator.hpp