W3cubDocs

/PointCloudLibrary

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

#include <pcl/octree/octree_container.h>

Public Member Functions

OctreeContainerPointIndex ()
Empty constructor. More...
virtual OctreeContainerPointIndex * deepCopy () const
Octree deep copy method. More...
bool operator== (const OctreeContainerBase &other) const override
Equal comparison operator. More...
void addPointIndex (index_t data_arg)
Add point index to container memory. More...
index_t getPointIndex () const
Retrieve point index from container. More...
void getPointIndices (Indices &data_vector_arg) const
Retrieve point indices from container. More...
uindex_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 index_t &)
Empty addPointIndex implementation. More...
void getPointIndex (index_t &) const
Empty getPointIndex implementation as this leaf node does not store any point indices. More...
void getPointIndices (Indices &) const
Empty getPointIndices implementation as this leaf node does not store any data. More...

Protected Attributes

index_t 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 169 of file octree_container.h.

Constructor & Destructor Documentation

OctreeContainerPointIndex()

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

Empty constructor.

Definition at line 172 of file octree_container.h.

References reset().

Referenced by deepCopy().

Member Function Documentation

addPointIndex()

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

Add point index to container memory.

This container stores a only a single point index.

Parameters
[in] data_arg index to be stored within leaf node.

Definition at line 198 of file octree_container.h.

References data_.

deepCopy()

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

Octree deep copy method.

Definition at line 176 of file octree_container.h.

References OctreeContainerPointIndex().

getPointIndex()

index_t 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 208 of file octree_container.h.

References data_.

getPointIndices()

void pcl::octree::OctreeContainerPointIndex::getPointIndices ( Indices & data_vector_arg ) const
inline

Retrieve point indices from container.

This container stores only a single point index

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

Definition at line 219 of file octree_container.h.

References data_.

getSize()

uindex_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 229 of file octree_container.h.

References data_.

operator==()

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

Equal comparison operator.

Parameters
[in] other OctreeContainerBase to compare with

Reimplemented from pcl::octree::OctreeContainerBase.

Definition at line 185 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 236 of file octree_container.h.

References data_.

Referenced by OctreeContainerPointIndex().

Member Data Documentation

data_

index_t pcl::octree::OctreeContainerPointIndex::data_
protected

Point index stored in octree.

Definition at line 243 of file octree_container.h.

Referenced by addPointIndex(), getPointIndex(), getPointIndices(), getSize(), operator==(), and reset().

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

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