Point Cloud Library (PCL)  1.8.1-dev
List of all members | Public Types | Public Member Functions | Protected Attributes
pcl::octree::OctreeIteratorBase< OctreeT > Class Template Reference

Abstract octree iterator class More...

#include <pcl/octree/octree_iterator.h>

+ Inheritance diagram for pcl::octree::OctreeIteratorBase< OctreeT >:

Public Types

typedef OctreeT::LeafNode LeafNode
 
typedef OctreeT::BranchNode BranchNode
 
typedef OctreeT::LeafContainer LeafContainer
 
typedef OctreeT::BranchContainer BranchContainer
 

Public Member Functions

 OctreeIteratorBase (unsigned int max_depth_arg=0)
 Empty constructor. More...
 
 OctreeIteratorBase (OctreeT *octree_arg, unsigned int max_depth_arg=0)
 Constructor. More...
 
 OctreeIteratorBase (const OctreeIteratorBase &src, unsigned int max_depth_arg=0)
 Copy constructor. More...
 
OctreeIteratorBaseoperator= (const OctreeIteratorBase &src)
 Copy operator. More...
 
virtual ~OctreeIteratorBase ()
 Empty deconstructor. More...
 
bool operator== (const OctreeIteratorBase &other) const
 Equal comparison operator. More...
 
bool operator!= (const OctreeIteratorBase &other) const
 Inequal comparison operator. More...
 
void reset ()
 Reset iterator. More...
 
const OctreeKeygetCurrentOctreeKey () const
 Get octree key for the current iterator octree node. More...
 
unsigned int getCurrentOctreeDepth () const
 Get the current depth level of octree. More...
 
OctreeNodegetCurrentOctreeNode () const
 Get the current octree node. More...
 
bool isBranchNode () const
 check if current node is a branch node More...
 
bool isLeafNode () const
 check if current node is a branch node More...
 
OctreeNodeoperator* () const
 *operator. More...
 
char getNodeConfiguration () const
 Get bit pattern of children configuration of current node. More...
 
const LeafContainergetLeafContainer () const
 Method for retrieving a single leaf container from the octree leaf node. More...
 
LeafContainergetLeafContainer ()
 Method for retrieving a single leaf container from the octree leaf node. More...
 
const BranchContainergetBranchContainer () const
 Method for retrieving the container from an octree branch node. More...
 
BranchContainergetBranchContainer ()
 Method for retrieving the container from an octree branch node. More...
 
virtual unsigned long getNodeID () const
 get a integer identifier for current node (note: identifier depends on tree depth). More...
 

Protected Attributes

OctreeT * octree_
 Reference to octree class. More...
 
IteratorStatecurrent_state_
 Pointer to current iterator state. More...
 
unsigned int max_octree_depth_
 Maximum octree depth. More...
 

Detailed Description

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

Abstract octree iterator class

Note
Octree iterator base class
Author
Julius Kammerl (juliu.nosp@m.s@ka.nosp@m.mmerl.nosp@m..de)

Definition at line 75 of file octree_iterator.h.

Member Typedef Documentation

template<typename OctreeT>
typedef OctreeT::BranchContainer pcl::octree::OctreeIteratorBase< OctreeT >::BranchContainer

Definition at line 84 of file octree_iterator.h.

template<typename OctreeT>
typedef OctreeT::BranchNode pcl::octree::OctreeIteratorBase< OctreeT >::BranchNode

Definition at line 81 of file octree_iterator.h.

template<typename OctreeT>
typedef OctreeT::LeafContainer pcl::octree::OctreeIteratorBase< OctreeT >::LeafContainer

Definition at line 83 of file octree_iterator.h.

template<typename OctreeT>
typedef OctreeT::LeafNode pcl::octree::OctreeIteratorBase< OctreeT >::LeafNode

Definition at line 80 of file octree_iterator.h.

Constructor & Destructor Documentation

template<typename OctreeT>
pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( unsigned int  max_depth_arg = 0)
inlineexplicit

Empty constructor.

Definition at line 89 of file octree_iterator.h.

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

template<typename OctreeT>
pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( OctreeT *  octree_arg,
unsigned int  max_depth_arg = 0 
)
inlineexplicit

Constructor.

Parameters
[in]octree_argOctree to be iterated. Initially the iterator is set to its root node.
[in]max_depth_argDepth limitation during traversal

Definition at line 100 of file octree_iterator.h.

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

template<typename OctreeT>
pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( const OctreeIteratorBase< OctreeT > &  src,
unsigned int  max_depth_arg = 0 
)
inline

Copy constructor.

Parameters
[in]srcthe iterator to copy into this
[in]max_depth_argDepth limitation during traversal

Definition at line 110 of file octree_iterator.h.

template<typename OctreeT>
virtual pcl::octree::OctreeIteratorBase< OctreeT >::~OctreeIteratorBase ( )
inlinevirtual

Empty deconstructor.

Definition at line 129 of file octree_iterator.h.

Member Function Documentation

template<typename OctreeT>
const BranchContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getBranchContainer ( ) const
inline
template<typename OctreeT>
BranchContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getBranchContainer ( )
inline
template<typename OctreeT>
unsigned int pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeDepth ( ) const
inline
template<typename OctreeT>
const OctreeKey& pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeKey ( ) const
inline
template<typename OctreeT>
OctreeNode* pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeNode ( ) const
inline

Get the current octree node.

Returns
pointer to current octree node

Definition at line 191 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

template<typename OctreeT>
const LeafContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getLeafContainer ( ) const
inline
template<typename OctreeT>
LeafContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getLeafContainer ( )
inline

Method for retrieving a single leaf container from the octree leaf node.

Returns
Reference to container class of leaf node.

Definition at line 283 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::isLeafNode(), pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

template<typename OctreeT>
char pcl::octree::OctreeIteratorBase< OctreeT >::getNodeConfiguration ( ) const
inline

Get bit pattern of children configuration of current node.

Returns
bit pattern (byte) describing the existence of 8 children of the current node

Definition at line 243 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::isBranchNode(), pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

template<typename OctreeT>
virtual unsigned long pcl::octree::OctreeIteratorBase< OctreeT >::getNodeID ( ) const
inlinevirtual
template<typename OctreeT>
bool pcl::octree::OctreeIteratorBase< OctreeT >::isBranchNode ( ) const
inline
template<typename OctreeT>
bool pcl::octree::OctreeIteratorBase< OctreeT >::isLeafNode ( ) const
inline
template<typename OctreeT>
bool pcl::octree::OctreeIteratorBase< OctreeT >::operator!= ( const OctreeIteratorBase< OctreeT > &  other) const
inline
template<typename OctreeT>
OctreeNode* pcl::octree::OctreeIteratorBase< OctreeT >::operator* ( ) const
inline
template<typename OctreeT>
OctreeIteratorBase& pcl::octree::OctreeIteratorBase< OctreeT >::operator= ( const OctreeIteratorBase< OctreeT > &  src)
inline
template<typename OctreeT>
bool pcl::octree::OctreeIteratorBase< OctreeT >::operator== ( const OctreeIteratorBase< OctreeT > &  other) const
inline
template<typename OctreeT>
void pcl::octree::OctreeIteratorBase< OctreeT >::reset ( )
inline

Member Data Documentation

template<typename OctreeT>
IteratorState* pcl::octree::OctreeIteratorBase< OctreeT >::current_state_
protected
template<typename OctreeT>
unsigned int pcl::octree::OctreeIteratorBase< OctreeT >::max_octree_depth_
protected
template<typename OctreeT>
OctreeT* pcl::octree::OctreeIteratorBase< OctreeT >::octree_
protected

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