BT_RLP_ResultIterator Class Reference

RLP Result Iterator. More...

#include <bt_rlp.h>

List of all members.

Public Member Functions

virtual const BT_RLP_ResultAt (size_t index)=0
 Returns the result at index from the set.
virtual const BT_RLP_ResultNext ()=0
 Returns the next result in the set.
virtual void Reset ()=0
 Reset the iterator to the beginning.
virtual BT_UInt32 Size () const =0
 Returns the number of results available.
virtual BT_RLP_ResultType Type () const =0
 Returns the type of results returned by the iterator.
virtual ~BT_RLP_ResultIterator ()
 Virtual Destructor.


Detailed Description

This class provides access to the results of RLP processing. You get the iterator for a context's results through the BT_RLP_Context::GetResultIterator member function: you cannot instantiate a result iterator directly.

It is your responsibility to destroy the iterator when you are finished with it by calling BT_RLP_Context::DestroyResultIterator.


Constructor & Destructor Documentation

virtual BT_RLP_ResultIterator::~BT_RLP_ResultIterator (  )  [virtual]

This is the virtual destructor for the BT_RLP_ResultIterator class hierarchy.


Member Function Documentation

virtual const BT_RLP_Result* BT_RLP_ResultIterator::At ( size_t  index  )  [pure virtual]

Returns the result at index in the set. The pointer returned is valid until the next call the Next() or At() member function. You should neither deallocate nor store it permanently.

Parameters:
index the location in the set of the result you wish to retrieve.
Returns:
The result specified.

virtual const BT_RLP_Result* BT_RLP_ResultIterator::Next (  )  [pure virtual]

Returns the next result in the set. The pointer returned is valid until the next call the Next() of At() member function. You should neither deallocate nor store it permanently.

Returns:
The next result in the set.

virtual void BT_RLP_ResultIterator::Reset (  )  [pure virtual]

Reset the iterator to the beginning so that a subsequent call to Next() will return the first element in the result.

virtual BT_UInt32 BT_RLP_ResultIterator::Size (  )  const [pure virtual]

This member function returns the number of results available to the iterator.

Returns:
The number of available results.

virtual BT_RLP_ResultType BT_RLP_ResultIterator::Type (  )  const [pure virtual]

This returns the type of the result that is returned by this iterator.

Returns:
The result type returned by this iterator.


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

Copyright © 2004-2008 Basis Technology Corporation. All Rights Reserved.