Public Member Functions | Static Public Member Functions | Friends | List of all members
ooc::NodeHandle Class Reference

#include <PointCloudAPI.h>

Public Member Functions

size_t Hash () const
 
 NodeHandle ()
 
 NodeHandle (NodeData const &node_data)
 
bool operator!= (NodeHandle const &other) const
 
bool operator< (NodeHandle const &other) const
 
bool operator== (NodeHandle const &other) const
 

Static Public Member Functions

static NodeHandle Invalid ()
 

Friends

class delta::on_disk::NodeHandleDeserializer
 
class delta::on_disk::NodeHandleSerializer
 

Detailed Description

A handle for a point cloud node. A NodeHandle is unique per point cloud tree. That is, if two handles belong to the same point cloud root, they will not compare equal.

Constructor & Destructor Documentation

ooc::NodeHandle::NodeHandle ( )
inline

Constructs an invalid node handle of indeterminate state.

ooc::NodeHandle::NodeHandle ( NodeData const &  node_data)

Constructs a node handle that is identical to node_data

Parameters
node_dataThe node handle to copy

Member Function Documentation

size_t ooc::NodeHandle::Hash ( ) const
static NodeHandle ooc::NodeHandle::Invalid ( )
static

Returns a node handle that represents an invalid node handle. The node handle returned by this function can be used as a representative invalid value. This value can be compared against other handles via the equality operators.

bool ooc::NodeHandle::operator!= ( NodeHandle const &  other) const
inline

Tests whether or not two node handles are unequal.

Parameters
otherThe node handle to compare against.
Returns
true if other is unequal to *this, false otherwise.
bool ooc::NodeHandle::operator< ( NodeHandle const &  other) const
inline

Puts a strict ordering on node handles.

Parameters
otherThe node handle to compare against.
Returns
true if other compares less than *this. Returns false otherwise.
bool ooc::NodeHandle::operator== ( NodeHandle const &  other) const
inline

Tests whether or not two node handles are equal.

Parameters
otherThe node handle to compare against.
Returns
true if other equals *this, false otherwise.

Friends And Related Function Documentation

friend class delta::on_disk::NodeHandleDeserializer
friend
friend class delta::on_disk::NodeHandleSerializer
friend

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