pcl::octree::OctreeIteratorBase — PointCloudLibrary

Абстрактный класс итератора октодерева Подробнее...

#include <pcl/octree/octree_iterator.h>

Открытые типы
using	iterator_category = std::forward_iterator_tag
using	value_type = const OctreeNode
using	difference_type = void
using	pointer = const OctreeNode *
using	reference = const OctreeNode &
using	LeafNode = typename OctreeT::LeafNode
using	BranchNode = typename OctreeT::BranchNode
using	LeafContainer = typename OctreeT::LeafContainer
using	BranchContainer = typename OctreeT::BranchContainer

Открытые функции-члены
	OctreeIteratorBase ()
	Конструктор без параметров. Подробнее...
	OctreeIteratorBase (uindex_t max_depth_arg)
	Конструктор. Подробнее...
	OctreeIteratorBase (OctreeT *octree_arg)
	Конструктор. Подробнее...
	OctreeIteratorBase (OctreeT *octree_arg, uindex_t max_depth_arg)
	Конструктор. Подробнее...
	OctreeIteratorBase (OctreeT octree_arg, uindex_t max_depth_arg, IteratorState current_state)
	Конструктор. Подробнее...
virtual	~OctreeIteratorBase ()=default
	Пустой деструктор. Подробнее...
bool	operator== (const OctreeIteratorBase &other) const
	Оператор сравнения на равенство. Подробнее...
bool	operator!= (const OctreeIteratorBase &other) const
	Оператор сравнения на неравенство. Подробнее...
void	reset ()
	Сбросить итератор. Подробнее...
virtual OctreeIteratorBase &	operator++ ()=0
	Оператор префиксного инкремента. Подробнее...
const OctreeKey &	getCurrentOctreeKey () const
	Получить ключ октодерева для текущего узла октодерева итератора. Подробнее...
uindex_t	getCurrentOctreeDepth () const
	Получить текущий уровень глубины октодерева. Подробнее...
OctreeNode *	getCurrentOctreeNode () const
	Получить текущий узел октодерева. Подробнее...
bool	isBranchNode () const
	Проверить, является ли текущий узел ветвевым Подробнее...
bool	isLeafNode () const
	Проверить, является ли текущий узел ветвевым Подробнее...
virtual OctreeNode *	operator* () const
	Оператор *. Подробнее...
char	getNodeConfiguration () const
	Получить битовый шаблон конфигурации дочерних узлов текущего узла. Подробнее...
const LeafContainer &	getLeafContainer () const
	Метод для получения контейнера листа из узла-листа октодерева. Подробнее...
LeafContainer &	getLeafContainer ()
	Метод для получения контейнера листа из узла-листа октодерева. Подробнее...
const BranchContainer &	getBranchContainer () const
	Метод для получения контейнера из ветвевого узла октодерева. Подробнее...
BranchContainer &	getBranchContainer ()
	Метод для получения контейнера из ветвевого узла октодерева. Подробнее...
virtual unsigned long	getNodeID () const
	Получить целочисленный идентификатор текущего узла (примечание: идентификатор зависит от глубины дерева). Подробнее...

Защищённые атрибуты
OctreeT *	octree_
	Ссылка на класс октодерева. Подробнее...
IteratorState *	current_state_
	Указатель на текущее состояние итератора. Подробнее...
uindex_t	max_octree_depth_
	Максимальная глубина октодерева. Подробнее...

Подробное описание

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

Абстрактный класс итератора октодерева

Примечание: Базовый класс итератора октодерева

Автор: Julius Kammerl (juliu.nosp@m.s@ka.nosp@m.mmerl.nosp@m..de)

Определение в строке 75 файла octree_iterator.h.

Документация псевдонимов типов-членов

BranchContainer

template<typename OctreeT >

using pcl::octree::OctreeIteratorBase< OctreeT >::BranchContainer = typename OctreeT::BranchContainer

Определение в строке 87 файла octree_iterator.h.

BranchNode

template<typename OctreeT >

using pcl::octree::OctreeIteratorBase< OctreeT >::BranchNode = typename OctreeT::BranchNode

Определение в строке 84 файла octree_iterator.h.

difference_type

template<typename OctreeT >

using pcl::octree::OctreeIteratorBase< OctreeT >::difference_type = void

Определение в строке 79 файла octree_iterator.h.

iterator_category

template<typename OctreeT >

using pcl::octree::OctreeIteratorBase< OctreeT >::iterator_category = std::forward_iterator_tag

Определение в строке 77 файла octree_iterator.h.

LeafContainer

template<typename OctreeT >

using pcl::octree::OctreeIteratorBase< OctreeT >::LeafContainer = typename OctreeT::LeafContainer

Определение в строке 86 файла octree_iterator.h.

LeafNode

template<typename OctreeT >

using pcl::octree::OctreeIteratorBase< OctreeT >::LeafNode = typename OctreeT::LeafNode

Определение в строке 83 файла octree_iterator.h.

pointer

template<typename OctreeT >

using pcl::octree::OctreeIteratorBase< OctreeT >::pointer = const OctreeNode*

Определение в строке 80 файла octree_iterator.h.

reference

template<typename OctreeT >

using pcl::octree::OctreeIteratorBase< OctreeT >::reference = const OctreeNode&

Определение в строке 81 файла octree_iterator.h.

value_type

template<typename OctreeT >

using pcl::octree::OctreeIteratorBase< OctreeT >::value_type = const OctreeNode

Определение в строке 78 файла octree_iterator.h.

Документация конструкторов и деструктора

OctreeIteratorBase() [1/5]

template<typename OctreeT >

pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( )

inline

Пустой конструктор.

Определение в строке 91 файла octree_iterator.h.

OctreeIteratorBase() [2/5]

template<typename OctreeT >

pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( uindex_t max_depth_arg )

inlineexplicit

Конструктор.

Параметры

[in] max_depth_arg Ограничение глубины при обходе

Определение в строке 96 файла octree_iterator.h.

Ссылки: pcl::octree::OctreeIteratorBase< OctreeT >::reset().

OctreeIteratorBase() [3/5]

template<typename OctreeT >

pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( OctreeT * octree_arg )

inline

Конструктор.

Параметры

[in] octree_arg Обходящееся октодерево. Изначально итератор установлен на его корневой узел.

Определение в строке 106 файла octree_iterator.h.

OctreeIteratorBase() [4/5]

template<typename OctreeT >

pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase	(	OctreeT *	octree_arg,
		uindex_t	max_depth_arg
	)

inlineexplicit

Конструктор.

Параметры

[in]	octree_arg	Обходящееся октодерево. Изначально итератор установлен на его корневой узел.
[in]	max_depth_arg	Ограничение глубины при обходе

Определение в строке 113 файла octree_iterator.h.

Ссылки: pcl::octree::OctreeIteratorBase< OctreeT >::reset().

OctreeIteratorBase() [5/5]

template<typename OctreeT >

pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase	(	OctreeT *	octree_arg,
		uindex_t	max_depth_arg,
		IteratorState *	current_state
	)

inlineexplicit

Конструктор.

Параметры

[in]	octree_arg	Обходящееся октодерево. Изначально итератор установлен на его корневой узел.
[in]	max_depth_arg	Ограничение глубины при обходе
[in]	current_state	Указатель на текущее состояние итератора

Предупреждение: Только для опытных пользователей.

Определение в строке 127 файла octree_iterator.h.

~OctreeIteratorBase()

template<typename OctreeT >

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

virtualdefault

Пустой деструктор.

Документация функций-членов

getBranchContainer() [1/2]

template<typename OctreeT >

BranchContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getBranchContainer ( )

inline

Метод для получения контейнера из ветвевого узла октодерева.

Возвращает: BranchContainer.

Определение в строке 328 файла octree_iterator.h.

Ссылки: pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::isBranchNode(), pcl::octree::IteratorState::node_ и pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

getBranchContainer() [2/2]

template<typename OctreeT >

const BranchContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getBranchContainer ( ) const

inline

Метод для получения контейнера из ветвевого узла октодерева.

Возвращает: BranchContainer.

Определение в строке 313 файла octree_iterator.h.

getCurrentOctreeDepth()

template<typename OctreeT >

uindex_t pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeDepth ( ) const

inline

Получить текущий уровень глубины октодерева.

Возвращает: уровень глубины

Определение в строке 196 файла octree_iterator.h.

Ссылки: pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::depth_ и pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

Используется в: pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getVoxelBounds().

getCurrentOctreeKey()

template<typename OctreeT >

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

inline

Получить ключ октодерева для текущего узла итератора.

Возвращает: ключ октодерева текущего узла

Определение в строке 184 файла octree_iterator.h.

Ссылки: pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::key_ и pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

Используется в: pcl::octree::OctreeIteratorBase< OctreeT >::getNodeID() и pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getVoxelBounds().

getCurrentOctreeNode()

template<typename OctreeT >

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

inline

Получить текущий узел октодерева.

Возвращает: указатель на текущий узел октодерева

Определение в строке 208 файла octree_iterator.h.

Ссылки: pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::node_ и pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

getLeafContainer() [1/2]

template<typename OctreeT >

LeafContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getLeafContainer ( )

inline

Метод для получения одного контейнера листа из узла-листа октодерева.

Возвращает: Ссылка на класс-контейнер узла-листа.

Определение в строке 298 файла octree_iterator.h.

Ссылки: pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::isLeafNode(), pcl::octree::IteratorState::node_ и pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

getLeafContainer() [2/2]

template<typename OctreeT >

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

inline

Метод для получения одного контейнера листа из узла-листа октодерева.

Возвращает: Ссылка на класс-контейнер узла-листа.

Определение в строке 283 файла octree_iterator.h.

getNodeConfiguration()

template<typename OctreeT >

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

inline

Получить битовый шаблон конфигурации потомков текущего узла.

Возвращает: битовый шаблон (байт), описывающий наличие 8 потомков текущего узла

Определение в строке 259 файла octree_iterator.h.

getNodeID()

template<typename OctreeT >

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

inlinevirtual

Получить целочисленный идентификатор текущего узла (примечание: идентификатор зависит от глубины дерева).

Возвращает: идентификатор узла.

Определение в строке 343 файла octree_iterator.h.

Ссылки: pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeKey(), pcl::octree::OctreeIteratorBase< OctreeT >::octree_, pcl::octree::OctreeKey::x, pcl::octree::OctreeKey::y и pcl::octree::OctreeKey::z.

isBranchNode()

template<typename OctreeT >

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

inline

Проверить, является ли текущий узел ветвевым узлом

Возвращает: true, если текущий узел является ветвевым узлом, иначе false

Определение в строке 220 файла octree_iterator.h.

Ссылки: pcl::octree::BRANCH_NODE, pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeNode::getNodeType(), pcl::octree::IteratorState::node_ и pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

Используется в: pcl::octree::OctreeIteratorBase< OctreeT >::getBranchContainer() и pcl::octree::OctreeIteratorBase< OctreeT >::getNodeConfiguration().

isLeafNode()

template<typename OctreeT >

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

inline

проверяет, является ли текущий узел узлом-ветвью

Возвращает: true, если текущий узел является узлом-ветвью, иначе false

Определение в строке 232 файла octree_iterator.h.

Ссылки на pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeNode::getNodeType(), pcl::octree::LEAF_NODE, pcl::octree::IteratorState::node_ и pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

Используется в pcl::octree::OctreeIteratorBase< OctreeT >::getLeafContainer().

operator!=()

template<typename OctreeT >

bool pcl::octree::OctreeIteratorBase< OctreeT >::operator!= ( const OctreeIteratorBase< OctreeT > & other ) const

inline

Оператор сравнения на неравенство.

Параметры

[in] other OctreeIteratorBase для сравнения

Определение в строке 159 файла octree_iterator.h.

Ссылается на pcl::octree::OctreeIteratorBase< OctreeT >::operator==().

operator*()

template<typename OctreeT >

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

inlinevirtual

Оператор разыменования *.

Возвращает: указатель на текущий узел октодерева

Переопределён в pcl::octree::OctreeLeafNodeBreadthFirstIterator< OctreeT > и pcl::octree::OctreeLeafNodeDepthFirstIterator< OctreeT >.

Определение в строке 244 файла octree_iterator.h.

Ссылки на pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::node_ и pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

operator++()

template<typename OctreeT >

virtual OctreeIteratorBase& pcl::octree::OctreeIteratorBase< OctreeT >::operator++ ( )

pure virtual

Оператор префиксного инкремента.

Примечание: переход к следующему узлу октодерева

Реализован в pcl::octree::OctreeLeafNodeBreadthFirstIterator< OctreeT >, pcl::octree::OctreeLeafNodeDepthFirstIterator< OctreeT >, pcl::octree::OctreeBreadthFirstIterator< OctreeT > и pcl::octree::OctreeDepthFirstIterator< OctreeT >.

operator==()

template<typename OctreeT >

bool pcl::octree::OctreeIteratorBase< OctreeT >::operator== ( const OctreeIteratorBase< OctreeT > & other ) const

inline

Оператор сравнения на равенство.

Параметры

[in] other OctreeIteratorBase для сравнения

Определение в строке 140 файла octree_iterator.h.

Ссылки на pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::key_, pcl::octree::OctreeIteratorBase< OctreeT >::max_octree_depth_ и pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

Используется в pcl::octree::OctreeIteratorBase< OctreeT >::operator!=().

reset()

template<typename OctreeT >

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

inline

Сбросить итератор.

Определение в строке 166 файла octree_iterator.h.

Ссылки на pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::max_octree_depth_ и pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

Используется в pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator(), pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset() и pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().

Описание данных-членов

current_state_

template<typename OctreeT >

IteratorState* pcl::octree::OctreeIteratorBase< OctreeT >::current_state_

protected

Указатель на текущее состояние итератора.

Определение в строке 367 файла octree_iterator.h.

max_octree_depth_

template<typename OctreeT >

uindex_t pcl::octree::OctreeIteratorBase< OctreeT >::max_octree_depth_

protected

Максимальная глубина октодерева.

Определение в строке 370 файла octree_iterator.h.

Используется в pcl::octree::OctreeIteratorBase< OctreeT >::operator==() и pcl::octree::OctreeIteratorBase< OctreeT >::reset().

octree_

template<typename OctreeT >

OctreeT* pcl::octree::OctreeIteratorBase< OctreeT >::octree_

protected

Ссылка на класс октодерева.

Определение в строке 364 файла octree_iterator.h.

Документация этого класса создана на основе следующего файла:

pcl/octree/octree_iterator.h

© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1octree_1_1_octree_iterator_base.html

Открытые типы

Открытые функции-члены

Защищённые атрибуты

Подробное описание

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

Документация псевдонимов типов-членов

BranchContainer

BranchNode

difference_type

iterator_category

LeafContainer

LeafNode

pointer

reference

value_type

Документация конструкторов и деструктора

OctreeIteratorBase() [1/5]

OctreeIteratorBase() [2/5]

OctreeIteratorBase() [3/5]

OctreeIteratorBase() [4/5]

OctreeIteratorBase() [5/5]

~OctreeIteratorBase()

Документация функций-членов

getBranchContainer() [1/2]

getBranchContainer() [2/2]

getCurrentOctreeDepth()

getCurrentOctreeKey()

getCurrentOctreeNode()

getLeafContainer() [1/2]

getLeafContainer() [2/2]

getNodeConfiguration()

getNodeID()

isBranchNode()

isLeafNode()

operator!=()

operator*()

operator++()

operator==()

reset()

Описание данных-членов

current_state_

max_octree_depth_

octree_

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