Point Cloud Library (PCL) 1.12.1
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Protected Attributes
pcl::octree::BufferedBranchNode< ContainerT > Class Template Reference

#include <pcl/octree/octree2buf_base.h>

Inheritance diagram for pcl::octree::BufferedBranchNode< ContainerT >:
Collaboration diagram for pcl::octree::BufferedBranchNode< ContainerT >:

Public Member Functions

 BufferedBranchNode ()
 Empty constructor.
 BufferedBranchNode (const BufferedBranchNode &source)
 Copy constructor.
BufferedBranchNode & operator= (const BufferedBranchNode &source_arg)
 Copy operator.
 ~BufferedBranchNode ()
 Empty constructor.
BufferedBranchNode * deepCopy () const override
 Method to perform a deep copy of the octree.
OctreeNode * getChildPtr (unsigned char buffer_arg, unsigned char index_arg) const
 Get child pointer in current branch node.
void setChildPtr (unsigned char buffer_arg, unsigned char index_arg, OctreeNode *newNode_arg)
 Set child pointer in current branch node.
bool hasChild (unsigned char buffer_arg, unsigned char index_arg) const
 Check if branch is pointing to a particular child node.
node_type_t getNodeType () const override
 Get the type of octree node.
void reset ()
 Reset branch node container for every branch buffer.
const ContainerT * operator-> () const
 Get const pointer to container.
ContainerT * operator-> ()
 Get pointer to container.
const ContainerT & operator* () const
 Get const reference to container.
ContainerT & operator* ()
 Get reference to container.
const ContainerT & getContainer () const
 Get const reference to container.
ContainerT & getContainer ()
 Get reference to container.
const ContainerT * getContainerPtr () const
 Get const pointer to container.
ContainerT * getContainerPtr ()
 Get pointer to container.
Public Member Functions inherited from pcl::octree::OctreeNode
 OctreeNode ()
virtual ~OctreeNode ()

Protected Attributes

ContainerT container_
OctreeNode * child_node_array_ [2][8]

Detailed Description

template<typename ContainerT>
class pcl::octree::BufferedBranchNode< ContainerT >

Definition at line 53 of file octree2buf_base.h.

Constructor & Destructor Documentation

◆ BufferedBranchNode() [1/2]

template<typename ContainerT>
pcl::octree::BufferedBranchNode< ContainerT >::BufferedBranchNode ( )
inline

Empty constructor.

Definition at line 57 of file octree2buf_base.h.

Referenced by pcl::octree::BufferedBranchNode< BranchContainerT >::deepCopy().

◆ BufferedBranchNode() [2/2]

template<typename ContainerT>
pcl::octree::BufferedBranchNode< ContainerT >::BufferedBranchNode ( const BufferedBranchNode< ContainerT > & source)
inline

Copy constructor.

Definition at line 60 of file octree2buf_base.h.

◆ ~BufferedBranchNode()

template<typename ContainerT>
pcl::octree::BufferedBranchNode< ContainerT >::~BufferedBranchNode ( )
inline

Empty constructor.

Definition at line 80 of file octree2buf_base.h.

Member Function Documentation

◆ deepCopy()

template<typename ContainerT>
BufferedBranchNode * pcl::octree::BufferedBranchNode< ContainerT >::deepCopy ( ) const
inlineoverridevirtual

Method to perform a deep copy of the octree.

Implements pcl::octree::OctreeNode.

Definition at line 84 of file octree2buf_base.h.

◆ getChildPtr()

template<typename ContainerT>
OctreeNode * pcl::octree::BufferedBranchNode< ContainerT >::getChildPtr ( unsigned char buffer_arg,
unsigned char index_arg ) const
inline

Get child pointer in current branch node.

Parameters
buffer_argbuffer selector
index_argindex of child in node
Returns
pointer to child node

Definition at line 95 of file octree2buf_base.h.

Referenced by pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::branchHasChild(), pcl::octree::Octree2BufBase< OctreeContainerPointIndices, OctreeContainerEmpty >::createLeaf(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::deleteBranch(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::deleteBranchChild(), pcl::octree::Octree2BufBase< OctreeContainerPointIndices, OctreeContainerEmpty >::deserializeTree(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::deserializeTreeRecursive(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::findLeafRecursive(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::getBranchBitPattern(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::getBranchBitPattern(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::getBranchChildPtr(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::getBranchXORBitPattern(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::serializeTreeRecursive(), and pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::treeCleanUpRecursive().

◆ getContainer() [1/2]

template<typename ContainerT>
ContainerT & pcl::octree::BufferedBranchNode< ContainerT >::getContainer ( )
inline

Get reference to container.

Definition at line 178 of file octree2buf_base.h.

◆ getContainer() [2/2]

template<typename ContainerT>
const ContainerT & pcl::octree::BufferedBranchNode< ContainerT >::getContainer ( ) const
inline

Get const reference to container.

Definition at line 171 of file octree2buf_base.h.

◆ getContainerPtr() [1/2]

template<typename ContainerT>
ContainerT * pcl::octree::BufferedBranchNode< ContainerT >::getContainerPtr ( )
inline

Get pointer to container.

Definition at line 192 of file octree2buf_base.h.

◆ getContainerPtr() [2/2]

template<typename ContainerT>
const ContainerT * pcl::octree::BufferedBranchNode< ContainerT >::getContainerPtr ( ) const
inline

Get const pointer to container.

Definition at line 185 of file octree2buf_base.h.

◆ getNodeType()

template<typename ContainerT>
node_type_t pcl::octree::BufferedBranchNode< ContainerT >::getNodeType ( ) const
inlineoverridevirtual

Get the type of octree node.

Returns LEAVE_NODE type

Implements pcl::octree::OctreeNode.

Definition at line 129 of file octree2buf_base.h.

◆ hasChild()

template<typename ContainerT>
bool pcl::octree::BufferedBranchNode< ContainerT >::hasChild ( unsigned char buffer_arg,
unsigned char index_arg ) const
inline

Check if branch is pointing to a particular child node.

Parameters
buffer_argbuffer selector
index_argindex of child in node
Returns
"true" if pointer to child node exists; "false" otherwise

Definition at line 121 of file octree2buf_base.h.

Referenced by pcl::octree::Octree2BufBase< OctreeContainerPointIndices, OctreeContainerEmpty >::createLeaf(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::deleteBranchChild(), pcl::octree::Octree2BufBase< OctreeContainerPointIndices, OctreeContainerEmpty >::deserializeTree(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::deserializeTreeRecursive(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::serializeTreeRecursive(), and pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::treeCleanUpRecursive().

◆ operator*() [1/2]

template<typename ContainerT>
ContainerT & pcl::octree::BufferedBranchNode< ContainerT >::operator* ( )
inline

Get reference to container.

Definition at line 164 of file octree2buf_base.h.

◆ operator*() [2/2]

template<typename ContainerT>
const ContainerT & pcl::octree::BufferedBranchNode< ContainerT >::operator* ( ) const
inline

Get const reference to container.

Definition at line 157 of file octree2buf_base.h.

◆ operator->() [1/2]

template<typename ContainerT>
ContainerT * pcl::octree::BufferedBranchNode< ContainerT >::operator-> ( )
inline

Get pointer to container.

Definition at line 150 of file octree2buf_base.h.

◆ operator->() [2/2]

template<typename ContainerT>
const ContainerT * pcl::octree::BufferedBranchNode< ContainerT >::operator-> ( ) const
inline

Get const pointer to container.

Definition at line 143 of file octree2buf_base.h.

◆ operator=()

template<typename ContainerT>
BufferedBranchNode & pcl::octree::BufferedBranchNode< ContainerT >::operator= ( const BufferedBranchNode< ContainerT > & source_arg)
inline

Copy operator.

Definition at line 67 of file octree2buf_base.h.

◆ reset()

template<typename ContainerT>
void pcl::octree::BufferedBranchNode< ContainerT >::reset ( )
inline

Reset branch node container for every branch buffer.

Definition at line 136 of file octree2buf_base.h.

Referenced by pcl::octree::BufferedBranchNode< BranchContainerT >::BufferedBranchNode().

◆ setChildPtr()

template<typename ContainerT>
void pcl::octree::BufferedBranchNode< ContainerT >::setChildPtr ( unsigned char buffer_arg,
unsigned char index_arg,
OctreeNode * newNode_arg )
inline

Set child pointer in current branch node.

Parameters
buffer_argbuffer selector
index_argindex of child in node
newNode_argpointer to new child node

Definition at line 107 of file octree2buf_base.h.

Referenced by pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::createBranchChild(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::createLeafChild(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::deleteBranch(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::deleteBranchChild(), pcl::octree::Octree2BufBase< OctreeContainerPointIndices, OctreeContainerEmpty >::deleteTree(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::deserializeTreeRecursive(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::setBranchChildPtr(), and pcl::octree::Octree2BufBase< OctreeContainerPointIndices, OctreeContainerEmpty >::setTreeDepth().

Member Data Documentation

◆ child_node_array_

template<typename ContainerT>
OctreeNode* pcl::octree::BufferedBranchNode< ContainerT >::child_node_array_[2][8]
protected

Definition at line 200 of file octree2buf_base.h.

Referenced by pcl::octree::BufferedBranchNode< BranchContainerT >::operator=().

◆ container_

template<typename ContainerT>
ContainerT pcl::octree::BufferedBranchNode< ContainerT >::container_
protected

Definition at line 198 of file octree2buf_base.h.

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