ZTBIter Class Reference
[Tuplebase]

Allows one to walk over the set of tuples in a ZTB as described by a ZTBQuery. More...

#include <ZTB.h>

List of all members.

Public Member Functions

ZTBIteroperator= (const ZTBIter &iOther)
 Update the iterator to reference unvisited tuples in iOther.
 operator operator_bool_type () const
 Returns true-equivalent if still referencing a tuple.
void Advance ()
 Move on to the next tuple.
size_t Advance (size_t iCount)
 Skip past no more than iCount tuples, returning the number that were actually skipped.
size_t AdvanceAll ()
 Skip past every tuple, returning the number that were skipped.
ZTuple Get () const
 Return the currently referenced tuple.
uint64 GetID () const
 Return the ID of the currently referenced tuple.
void Get (uint64 *oID, ZTuple *oTuple) const
 Return the ID and value of the currently referenced tuple.
void Set (const ZTuple &iTuple)
 Replace the currently referenced tuple with iTuple.
void Erase ()
 Replace the currently referenced tuple with an empty tuple.
size_t EraseAll ()
 Replace all remaining tuples with an empty tuple, returning the number of tuples touched.
Constructors
 ZTBIter ()
 Default constructor, an iterator that's empty.
 ZTBIter (const ZTBIter &iOther)
 Creates a fresh iterator that independently references the unvisited tuples in iOther.
 ZTBIter (const ZTxn &iTxn, ZTB iTB, const ZTBQuery &iQuery)
 Iterator that accesses all tuples satisfying iQuery in tuplebase iTB, in the context of transaction iTxn.
 ZTBIter (const ZTBTxn &iTBTxn, const ZTBQuery &iQuery)
 Iterator that accesses all tuples satisfying iQuery in the tuplebase and transaction referenced by iTBTxn.


Detailed Description

Allows one to walk over the set of tuples in a ZTB as described by a ZTBQuery.


Constructor & Destructor Documentation

ZTBIter::ZTBIter ( const ZTBIter iOther  ) 

Creates a fresh iterator that independently references the unvisited tuples in iOther.

Instantiate an iterator referencing the same set of tuples as iOther. Subsequent changes to iOther will not affect this iterator.


Member Function Documentation

ZTBIter & ZTBIter::operator= ( const ZTBIter iOther  ) 

Update the iterator to reference unvisited tuples in iOther.

Reference the same set of tuples as iOther. Subsequent changes to iOther will not affect this iterator.

void ZTBIter::Advance (  ) 

Move on to the next tuple.

Update the iterator so that Get and GetID will return the next tuple from the result set.


The documentation for this class was generated from the following files:
Generated on Thu Jul 26 11:22:08 2007 for ZooLib by  doxygen 1.4.7