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

#include <sprk_ooc.h>

Collaboration diagram for HPS::OOC::QueryIterator:

Public Types
enum	Status { Status::Alive, Status::Dead, Status::ErrorUnknownFailure, Status::ErrorFileSystemFailure, Status::ErrorDeserializationFailure, Status::ErrorCouldNotFindNode, Status::ErrorCorruptNode }
	Designates the status of an QueryIterator. More...

enum	Storage { Storage::Memory, Storage::Disk }
	Designates the location of an QueryResult. More...

Public Member Functions
	QueryIterator ()
	Constructs a dead query iterator. More...

	QueryIterator (QueryIterator &&other)
	Constructs a query iterator from another with the same state and progress of other. More...

	~QueryIterator ()

Status	GetStatus () const

NodeHandle	GetNodeHandle () const
	Yields the currently processed point's node handle. More...

RGBColor	GetNodePointColor () const
	Yields the currently processed point's RGB color. More...

Point	GetNodePoint () const
	Yields the currently processed point's coordinates in object space. More...

size_t	GetNodePointIndex () const
	Yields the currently processed point's index. More...

Storage	GetStorage () const
	Yields the currently processed point's storage. More...

void	Next ()
	Advances the iterator to the next point result. More...

Private Member Functions
	QueryIterator (void *in_opaque)

	QueryIterator (QueryIterator const &other)=delete

Private Attributes
void *	opaque

Friends
class	HPS::OOC::PointCloud

Detailed Description

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

Member Enumeration Documentation

◆ Status

enum HPS::OOC::QueryIterator::Status

strong

Designates the status of an QueryIterator.

Enumerator
Alive
Dead
ErrorUnknownFailure
ErrorFileSystemFailure
ErrorDeserializationFailure
ErrorCouldNotFindNode
ErrorCorruptNode

◆ Storage

enum HPS::OOC::QueryIterator::Storage

strong

Designates the location of an QueryResult.

Enumerator
Memory
Disk

Constructor & Destructor Documentation

◆ QueryIterator() [1/4]

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

Constructs a dead query iterator.

Returns: The dead iterator

◆ QueryIterator() [2/4]

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.

◆ ~QueryIterator()

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

◆ QueryIterator() [3/4]

HPS::OOC::QueryIterator::QueryIterator ( void * in_opaque )

private

◆ QueryIterator() [4/4]

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

privatedelete

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.

Friends And Related Function Documentation

◆ HPS::OOC::PointCloud

friend class HPS::OOC::PointCloud

friend

Member Data Documentation

◆ opaque

void* HPS::OOC::QueryIterator::opaque