IResidentBlockIterator Class Reference

Defines an iterator interface that iterates all RowBlock objects held resident by an ISwapAssistant object. More...

List of all members.

Public Member Functions

virtual bool HasMore ()=0
 Test whether there are more RowBlocks.
virtual Simba::DSI::RowBlockNext ()=0
 Retrieves the next RowBlock if HasMore() returns true, throws an exception otherwise.
virtual ~IResidentBlockIterator ()
 Destructor.

Protected Member Functions

 IResidentBlockIterator ()
 Constructor.

Detailed Description

Defines an iterator interface that iterates all RowBlock objects held resident by an ISwapAssistant object.

It is designed to work with ISwapAssistant so that the details of how the resident blocks are held by a particular ISwapAssistant implementation is hidden from the user (i.e., SwapManager). It also means that every ISwapAssistant implementation should be accompanied by an IResidentBlockIterator implementation.


Constructor & Destructor Documentation

virtual ~IResidentBlockIterator (  )  [inline, virtual]

Destructor.

IResidentBlockIterator (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual bool HasMore (  )  [pure virtual]

Test whether there are more RowBlocks.

This method _MUST_ be called before calling Next(). Otherwise Next() can throw an exception.

Returns:
True if there is more RowBlocks, false otherwise.
virtual Simba::DSI::RowBlock* Next (  )  [pure virtual]

Retrieves the next RowBlock if HasMore() returns true, throws an exception otherwise.

Exceptions:
DSIException when HasMore() returns false.
Returns:
The next RowBlock if HasMore() returns true, throws SupportException otherwise.

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

Generated on Wed May 17 14:21:16 2017 for SimbaEngine 10.1.3.1011 by simba