Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

ooc::query::QueryIterator Class Reference

#include <PointCloudAPI.h>

List of all members.

Public Types

enum  Status {
  Status_Alive, Status_Dead, Status_Error_Unknown_Failure, Status_Error_File_System_Failure,
  Status_Error_Deserialization_Failure, Status_Error_Could_Not_Find_Node, Status_Error_Corrupt_Node
}

Public Member Functions

void Advance ()
Status GetStatus () const
QueryResult const & operator* () const
QueryResult const * operator-> () const
 QueryIterator ()
 QueryIterator (QueryIterator &&other)
 ~QueryIterator ()

Friends

QueryIterator QueryPoints (Env, Filter &)

Detailed Description

The iterator returned from a call to ooc::query::QueryPoints.


Member Enumeration Documentation

Enumerator:
Status_Alive 
Status_Dead 
Status_Error_Unknown_Failure 
Status_Error_File_System_Failure 
Status_Error_Deserialization_Failure 
Status_Error_Could_Not_Find_Node 
Status_Error_Corrupt_Node 

Constructor & Destructor Documentation

ooc::query::QueryIterator::QueryIterator ( )

Constructs a dead query iterator.

Returns:
The dead iterator.
ooc::query::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.
ooc::query::QueryIterator::~QueryIterator ( )

Member Function Documentation

void ooc::query::QueryIterator::Advance ( )

Advances the iterator to the next point result. This is only legal to call when this->GetStatus() returns ooc::query::QueryIterator::Status_Alive.

Status ooc::query::QueryIterator::GetStatus ( ) const
Returns:
the status of the iterator.
QueryResult const& ooc::query::QueryIterator::operator* ( ) const

This is only legal to call when this->GetStatus() returns ooc::query::QueryIterator::Status_Alive.

Returns:
the current point result of the query.
QueryResult const* ooc::query::QueryIterator::operator-> ( ) const

This is only legal to call when this->GetStatus() returns ooc::query::QueryIterator::Status_Alive.

Returns:
the current point result of the query.

Friends And Related Function Documentation

QueryIterator QueryPoints ( Env  ,
Filter  
) [friend]

Allows users to query the points in a point cloud tree. Based on the input filter, the returned points may include both points in memory and on disk.

Parameters:
envThe environment of the point cloud to query points from.
filterThe filter to select points with.
Returns:
an iterator to the queried points.

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