Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Member Functions | Protected Attributes
pcl::octree::OctreeContainerPointIndex Class Reference

Octree container class that does store a single point index. More...

#include <pcl/octree/octree_container.h>

+ Inheritance diagram for pcl::octree::OctreeContainerPointIndex:

Public Member Functions

 OctreeContainerPointIndex ()
 Empty constructor. More...
 
virtual OctreeContainerPointIndexdeepCopy () const
 Octree deep copy method. More...
 
bool operator== (const OctreeContainerBase &other) const override
 Equal comparison operator. More...
 
void addPointIndex (int data_arg)
 Add point index to container memory. More...
 
int getPointIndex () const
 Retrieve point index from container. More...
 
void getPointIndices (std::vector< int > &data_vector_arg) const
 Retrieve point indices from container. More...
 
size_t getSize () const override
 Get size of container (number of DataT objects) More...
 
void reset () override
 Reset leaf node memory to zero. More...
 
- Public Member Functions inherited from pcl::octree::OctreeContainerBase
virtual ~OctreeContainerBase ()=default
 
bool operator!= (const OctreeContainerBase &other) const
 Inequal comparison operator. More...
 
void addPointIndex (const int &)
 Empty addPointIndex implementation. More...
 
void getPointIndex (int &) const
 Empty getPointIndex implementation as this leaf node does not store any point indices. More...
 
void getPointIndices (std::vector< int > &) const
 Empty getPointIndices implementation as this leaf node does not store any data. More...
 

Protected Attributes

int data_
 Point index stored in octree. More...
 

Detailed Description

Octree container class that does store a single point index.

Note
Enables the octree to store a single DataT element within its leaf nodes.
Author
Julius Kammerl (juliu.nosp@m.s@ka.nosp@m.mmerl.nosp@m..de)

Definition at line 174 of file octree_container.h.

Constructor & Destructor Documentation

◆ OctreeContainerPointIndex()

pcl::octree::OctreeContainerPointIndex::OctreeContainerPointIndex ( )
inline

Empty constructor.

Definition at line 178 of file octree_container.h.

References pcl::octree::OctreeContainerBase::reset().

Member Function Documentation

◆ addPointIndex()

void pcl::octree::OctreeContainerPointIndex::addPointIndex ( int  data_arg)
inline

Add point index to container memory.

This container stores a only a single point index.

Parameters
[in]data_argindex to be stored within leaf node.

Definition at line 205 of file octree_container.h.

◆ deepCopy()

virtual OctreeContainerPointIndex* pcl::octree::OctreeContainerPointIndex::deepCopy ( ) const
inlinevirtual

Octree deep copy method.

Definition at line 185 of file octree_container.h.

◆ getPointIndex()

int pcl::octree::OctreeContainerPointIndex::getPointIndex ( ) const
inline

Retrieve point index from container.

This container stores a only a single point index

Returns
index stored within container.

Definition at line 214 of file octree_container.h.

◆ getPointIndices()

void pcl::octree::OctreeContainerPointIndex::getPointIndices ( std::vector< int > &  data_vector_arg) const
inline

Retrieve point indices from container.

This container stores only a single point index

Parameters
[out]data_vector_argvector of point indices to be stored within data vector

Definition at line 223 of file octree_container.h.

◆ getSize()

size_t pcl::octree::OctreeContainerPointIndex::getSize ( ) const
inlineoverridevirtual

Get size of container (number of DataT objects)

Returns
number of DataT elements in leaf node container.

Reimplemented from pcl::octree::OctreeContainerBase.

Definition at line 233 of file octree_container.h.

◆ operator==()

bool pcl::octree::OctreeContainerPointIndex::operator== ( const OctreeContainerBase other) const
inlineoverridevirtual

Equal comparison operator.

Parameters
[in]otherOctreeContainerBase to compare with

Reimplemented from pcl::octree::OctreeContainerBase.

Definition at line 194 of file octree_container.h.

References data_.

◆ reset()

void pcl::octree::OctreeContainerPointIndex::reset ( )
inlineoverridevirtual

Reset leaf node memory to zero.

Implements pcl::octree::OctreeContainerBase.

Definition at line 240 of file octree_container.h.

Member Data Documentation

◆ data_

int pcl::octree::OctreeContainerPointIndex::data_
protected

Point index stored in octree.

Definition at line 246 of file octree_container.h.

Referenced by operator==().


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