Abstract octree iterator class More...

#include <pcl/octree/octree_iterator.h>

Inheritance diagram for pcl::octree::OctreeIteratorBase< DataT, OctreeT >:

Collaboration diagram for pcl::octree::OctreeIteratorBase< DataT, OctreeT >:

Public Types
typedef OctreeT::LeafNode	LeafNode

typedef OctreeT::BranchNode	BranchNode

Public Member Functions
	OctreeIteratorBase (OctreeT &octree_arg)
	Constructor. More...

	OctreeIteratorBase (const OctreeIteratorBase &src)
	Copy constructor. More...

OctreeIteratorBase &	operator= (const OctreeIteratorBase &src)
	Copy operator. More...

virtual	~OctreeIteratorBase ()
	Empty deconstructor. More...

void	reset ()
	initialize iterator globals More...

const OctreeKey &	getCurrentOctreeKey () const
	Get octree key for the current iterator octree node. More...

unsigned int	getCurrentOctreeDepth () const
	Get the current depth level of octree. More...

OctreeNode *	getCurrentOctreeNode () const
	Get the current octree node. More...

OctreeNode *	operator* () const
	*operator. 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...

char	getNodeConfiguration () const
	Get bit pattern of children configuration of current node. More...

virtual void	getData (DataT &data_arg) const
	Method for retrieving a single DataT element from the octree leaf node. More...

virtual void	getData (std::vector< DataT > &dataVector_arg) const
	Method for retrieving a vector of DataT elements from the octree laef node. More...

virtual std::size_t	getSize () const
	Method for retrieving the size of the DataT vector from the octree laef node. More...

virtual unsigned long	getNodeID () const
	get a integer identifier for current node (note: identifier depends on tree depth). More...

Detailed Description

template<typename DataT, typename OctreeT>
class pcl::octree::OctreeIteratorBase< DataT, 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 69 of file octree_iterator.h.

Member Typedef Documentation

template<typename DataT, typename OctreeT>

typedef OctreeT::BranchNode pcl::octree::OctreeIteratorBase< DataT, OctreeT >::BranchNode

Definition at line 75 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

typedef OctreeT::LeafNode pcl::octree::OctreeIteratorBase< DataT, OctreeT >::LeafNode

Definition at line 74 of file octree_iterator.h.

Constructor & Destructor Documentation

template<typename DataT, typename OctreeT>

pcl::octree::OctreeIteratorBase< DataT, OctreeT >::OctreeIteratorBase ( OctreeT & octree_arg )

inlineexplicit

Constructor.

Parameters

[in] octree_arg Octree to be iterated. Initially the iterator is set to its root node.

Definition at line 81 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

pcl::octree::OctreeIteratorBase< DataT, OctreeT >::OctreeIteratorBase ( const OctreeIteratorBase< DataT, OctreeT > & src )

inline

Copy constructor.

Parameters

[in] src the iterator to copy into this

Definition at line 90 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

virtual pcl::octree::OctreeIteratorBase< DataT, OctreeT >::~OctreeIteratorBase ( )

inlinevirtual

Empty deconstructor.

Definition at line 111 of file octree_iterator.h.

Member Function Documentation

template<typename DataT, typename OctreeT>

unsigned int pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getCurrentOctreeDepth ( ) const

inline

Get the current depth level of octree.

Returns: depth level

Definition at line 140 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

const OctreeKey& pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getCurrentOctreeKey ( ) const

inline

Get octree key for the current iterator octree node.

Returns: octree key of current node

Definition at line 131 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

OctreeNode* pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getCurrentOctreeNode ( ) const

inline

Get the current octree node.

Returns: pointer to current octree node

Definition at line 149 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

virtual void pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getData ( DataT & data_arg ) const

inlinevirtual

Method for retrieving a single DataT element from the octree leaf node.

Parameters

[in] data_arg reference to return pointer of leaf node DataT element.

Definition at line 207 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

virtual void pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getData ( std::vector< DataT > & dataVector_arg ) const

inlinevirtual

Method for retrieving a vector of DataT elements from the octree laef node.

Parameters

[in] dataVector_arg reference to DataT vector that is extended with leaf node DataT elements.

Definition at line 219 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

char pcl::octree::OctreeIteratorBase< DataT, 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 185 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

virtual unsigned long pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getNodeID ( ) const

inlinevirtual

get a integer identifier for current node (note: identifier depends on tree depth).

Returns: node id.

Definition at line 240 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

virtual std::size_t pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getSize ( ) const

inlinevirtual

Method for retrieving the size of the DataT vector from the octree laef node.

Definition at line 229 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

bool pcl::octree::OctreeIteratorBase< DataT, OctreeT >::isBranchNode ( ) const

inline

check if current node is a branch node

Returns: true if current node is a branch node, false otherwise

Definition at line 167 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

bool pcl::octree::OctreeIteratorBase< DataT, OctreeT >::isLeafNode ( ) const

inline

check if current node is a branch node

Returns: true if current node is a branch node, false otherwise

Definition at line 176 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

OctreeNode* pcl::octree::OctreeIteratorBase< DataT, OctreeT >::operator* ( ) const

inline

*operator.

Returns: pointer to the current octree node

Definition at line 158 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

OctreeIteratorBase& pcl::octree::OctreeIteratorBase< DataT, OctreeT >::operator= ( const OctreeIteratorBase< DataT, OctreeT > & src )

inline

Copy operator.

Parameters

[in] src the iterator to copy into this

Definition at line 100 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

void pcl::octree::OctreeIteratorBase< DataT, OctreeT >::reset ( )

inline

initialize iterator globals

Definition at line 117 of file octree_iterator.h.

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

/builddir/build/BUILD/PCL-1.6.0-Source/octree/include/pcl/octree/octree_iterator.h

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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