Public Member Functions | Private Attributes
CopyBuffer Class Reference

a buffer holding the points being copied and a set of operations for manipulating the buffer. More...

#include <copyBuffer.h>

Inheritance diagram for CopyBuffer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void clean ()
 Removes all the points from the copy buffer.
 CopyBuffer (bool register_stats=false)
 Default Constructor.
 CopyBuffer (const CopyBuffer &copy)
 Copy Constructor.
bool empty () const
 Returns true if the buffer is empty, false otherwise.
const Cloudget () const
 Returns the points stored in the internal buffer as a const Cloud.
Cloudget ()
 Returns the points stored in the internal buffer as a Cloud.
std::string getStat () const
 Get the statistics of the copied points in string.
CopyBufferoperator= (const CopyBuffer &copy_buffer)
 Equal Operator.
void set (ConstCloudPtr cloud_ptr, const Selection &selection)
 Sets the points in the copy buffer.
 ~CopyBuffer ()
 Destructor.

Private Attributes

Cloud buffer_
 a cloud object holding all the copied points.

Detailed Description

a buffer holding the points being copied and a set of operations for manipulating the buffer.

Definition at line 49 of file copyBuffer.h.


Constructor & Destructor Documentation

CopyBuffer::CopyBuffer ( bool  register_stats = false) [inline]

Default Constructor.

This creates an empty buffer

Definition at line 54 of file copyBuffer.h.

Copy Constructor.

create a copy buffer by copying all the internal states of the passed copy buffer.

Parameters:
copythe copy buffer object used to initialize this object

Definition at line 45 of file copyBuffer.cpp.

Destructor.

Definition at line 67 of file copyBuffer.h.


Member Function Documentation

Removes all the points from the copy buffer.

Definition at line 81 of file copyBuffer.cpp.

bool CopyBuffer::empty ( ) const [inline]

Returns true if the buffer is empty, false otherwise.

Definition at line 108 of file copyBuffer.h.

const Cloud & CopyBuffer::get ( ) const

Returns the points stored in the internal buffer as a const Cloud.

Definition at line 69 of file copyBuffer.cpp.

Returns the points stored in the internal buffer as a Cloud.

Definition at line 75 of file copyBuffer.cpp.

std::string CopyBuffer::getStat ( ) const [virtual]

Get the statistics of the copied points in string.

Implements Statistics.

Definition at line 87 of file copyBuffer.cpp.

CopyBuffer & CopyBuffer::operator= ( const CopyBuffer copy_buffer)

Equal Operator.

Copy all the internal states to the this copy buffer object.

Parameters:
copy_bufferthe copy buffer object used to update the this object
Returns:
A reference to this.

Definition at line 51 of file copyBuffer.cpp.

void CopyBuffer::set ( ConstCloudPtr  cloud_ptr,
const Selection selection 
)

Sets the points in the copy buffer.

The passed selection pointer is used to get specified points from the stored cloud pointer and copy them into the internal buffer. Any points that currently exist in this buffer are removed and replaced with those passed. Note that this buffer is cleared prior to any checking of the state of the passed parameters.

Parameters:
cloud_ptra pointer to a cloud object whose points are to be copied
selectiona const reference to the selected points object

Definition at line 58 of file copyBuffer.cpp.


Member Data Documentation

a cloud object holding all the copied points.

Definition at line 115 of file copyBuffer.h.


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


pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:38:49