HPS::OOC::QueryIterator Class Reference

#include <sprk_ooc.h>

Public Types

enum  Status {
Alive, Dead, ErrorUnknownFailure, ErrorFileSystemFailure,
ErrorDeserializationFailure, ErrorCouldNotFindNode, ErrorCorruptNode
}


 
enum  Storage { Memory, Disk }
 

Public Member Functions

NodeHandle GetNodeHandle () const
 
Point GetNodePoint () const
 
RGBColor GetNodePointColor () const
 
size_t GetNodePointIndex () const
 
Status GetStatus () const
 
Storage GetStorage () const
 
void Next ()
 
QueryIteratoroperator= (QueryIterator &&other)
 
 QueryIterator ()
 
 QueryIterator (QueryIterator &&other)
 

Friends

class HPS::OOC::PointCloud
 

Detailed Description

The iterator returned from a call to OOC::PointCloud::QueryPoints.

Member Enumeration Documentation

◆ Status

Designates the status of an QueryIterator.

◆ Storage

Designates the location of an QueryResult.

Constructor & Destructor Documentation

◆ QueryIterator() [1/2]

HPS::OOC::QueryIterator::QueryIterator ( )

Constructs a dead query iterator.

Returns
The dead iterator

◆ QueryIterator() [2/2]

HPS::OOC::QueryIterator::QueryIterator ( QueryIterator &&  other)

Constructs a query iterator from another with the same state and progress of other.

Returns
The query iterator to construct from.

Member Function Documentation

◆ GetNodeHandle()

NodeHandle HPS::OOC::QueryIterator::GetNodeHandle ( ) const

Yields the currently processed point's node handle.

Returns
the node handle of the current result

◆ GetNodePoint()

Point HPS::OOC::QueryIterator::GetNodePoint ( ) const

Yields the currently processed point's coordinates in object space.

Returns
the object space coordinates for the point of the current result

◆ GetNodePointColor()

RGBColor HPS::OOC::QueryIterator::GetNodePointColor ( ) const

Yields the currently processed point's RGB color.

Returns
the RGB color for the point of the current result

◆ GetNodePointIndex()

size_t HPS::OOC::QueryIterator::GetNodePointIndex ( ) const

Yields the currently processed point's index.

Returns
the index for the point of the current result.

◆ GetStatus()

Status HPS::OOC::QueryIterator::GetStatus ( ) const
Returns
the status of the iterator.

◆ GetStorage()

Storage HPS::OOC::QueryIterator::GetStorage ( ) const

Yields the currently processed point's storage.

Returns
the storage for the point of the current result.

◆ Next()

void HPS::OOC::QueryIterator::Next ( )

Advances the iterator to the next point result. This is only legal to call when this->GetStatus() returns OOC::QueryIterator::Status::Alive.


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