gatb.core-API-1.4.2
CancellableIterator< Item > Class Template Reference

Iterator that can be cancelled at some point during iteration. More...

#include <IteratorHelpers.hpp>

Inheritance diagram for CancellableIterator< Item >:
Inheritance graph

Public Member Functions

 CancellableIterator (Iterator< Item > &ref, bool initRef=true)
 
void first ()
 
void next ()
 
bool isDone ()
 
Item & item ()
 
- Public Member Functions inherited from Iterator< Item >
Item * operator-> ()
 
Item & operator* ()
 
template<typename Functor >
void iterate (const Functor &f)
 
virtual void setItem (Item &i)
 
bool get (std::vector< Item > &current)
 
virtual void reset ()
 
virtual void finalize ()
 
virtual std::vector< Iterator< Item > * > getComposition ()
 
- Public Member Functions inherited from SmartPointer
void use ()
 
void forget ()
 
- Public Member Functions inherited from ISmartPointer
virtual ~ISmartPointer ()
 

Additional Inherited Members

- Protected Member Functions inherited from SmartPointer
 SmartPointer ()
 
virtual ~SmartPointer ()
 

Detailed Description

template<class Item>
class gatb::core::tools::dp::impl::CancellableIterator< Item >

Iterator that can be cancelled at some point during iteration.

This iterator iterates a referred iterator and will finish:

  • when the referred iterator is over or - when the cancel member variable is set to true

Constructor & Destructor Documentation

CancellableIterator ( Iterator< Item > &  ref,
bool  initRef = true 
)
inline

Constructor.

Parameters
[in]ref: the referred iterator
[in]initRef: will call 'first' on the reference if true

Member Function Documentation

void first ( )
inlinevirtual

Method that initializes the iteration.

Implements Iterator< Item >.

bool isDone ( )
inlinevirtual

Method telling whether the iteration is finished or not.

Returns
true if iteration is finished, false otherwise.

Implements Iterator< Item >.

Item& item ( )
inlinevirtual

Method that returns the current iterated item. Note that the returned type is the template type.

Returns
the current item in the iteration.

Implements Iterator< Item >.

void next ( )
inlinevirtual

Method that goes to the next item in the iteration.

Returns
status of the iteration

Implements Iterator< Item >.


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