QueryIterator

Types

Status

Fields

	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

Functions

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

Detailed Description

class QueryIterator

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

Public Types

enum Status

Values:

enumerator Status_Alive

enumerator Status_Dead

enumerator Status_Error_Unknown_Failure

enumerator Status_Error_File_System_Failure

enumerator Status_Error_Deserialization_Failure

enumerator Status_Error_Could_Not_Find_Node

enumerator Status_Error_Corrupt_Node

Public Functions

QueryIterator()

Constructs a dead query iterator.

Returns:The dead iterator.

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()

QueryResult const &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 *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.

Status GetStatus() const

Returns:the status of the iterator.

void Advance()

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