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:
Inheritance graph
[legend]
Collaboration diagram for pcl::octree::OctreeContainerPointIndex:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 OctreeContainerPointIndex ()
 Empty constructor.
 OctreeContainerPointIndex (const OctreeContainerPointIndex &source)
 Empty constructor.
virtual ~OctreeContainerPointIndex ()
 Empty deconstructor.
virtual OctreeContainerPointIndexdeepCopy () const
 Octree deep copy method.
virtual bool operator== (const OctreeContainerBase &other) const
 Equal comparison operator.
void addPointIndex (int data_arg)
 Add point index to container memory.
int getPointIndex () const
 Retrieve point index from container.
void getPointIndices (std::vector< int > &data_vector_arg) const
 Retrieve point indices from container.
size_t getSize () const
 Get size of container (number of DataT objects).
virtual void reset ()
 Reset leaf node memory to zero.

Protected Attributes

int data_
 Point index stored in octree.

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 (julius@kammerl.de)

Definition at line 208 of file octree_container.h.


Constructor & Destructor Documentation

pcl::octree::OctreeContainerPointIndex::OctreeContainerPointIndex (  )  [inline]

Empty constructor.

Definition at line 212 of file octree_container.h.

References reset().

pcl::octree::OctreeContainerPointIndex::OctreeContainerPointIndex ( const OctreeContainerPointIndex source  )  [inline]

Empty constructor.

Definition at line 219 of file octree_container.h.

virtual pcl::octree::OctreeContainerPointIndex::~OctreeContainerPointIndex (  )  [inline, virtual]

Empty deconstructor.

Definition at line 226 of file octree_container.h.


Member Function Documentation

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_arg index to be stored within leaf node.

Definition at line 252 of file octree_container.h.

References data_.

virtual OctreeContainerPointIndex* pcl::octree::OctreeContainerPointIndex::deepCopy (  )  const [inline, virtual]

Octree deep copy method.

Definition at line 232 of file octree_container.h.

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

References data_.

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_arg vector of point indices to be stored within data vector

Reimplemented from pcl::octree::OctreeContainerBase.

Definition at line 270 of file octree_container.h.

References data_.

size_t pcl::octree::OctreeContainerPointIndex::getSize (  )  const [inline]

Get size of container (number of DataT objects).

Returns:
number of DataT elements in leaf node container.

Definition at line 280 of file octree_container.h.

References data_.

virtual bool pcl::octree::OctreeContainerPointIndex::operator== ( const OctreeContainerBase other  )  const [inline, virtual]

Equal comparison operator.

Parameters:
[in] other OctreeContainerBase to compare with

Definition at line 241 of file octree_container.h.

References data_.

virtual void pcl::octree::OctreeContainerPointIndex::reset (  )  [inline, virtual]

Reset leaf node memory to zero.

Implements pcl::octree::OctreeContainerBase.

Definition at line 287 of file octree_container.h.

References data_.

Referenced by OctreeContainerPointIndex().


Member Data Documentation

Point index stored in octree.

Definition at line 293 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:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends