NullIterator< Item > Class Template Reference

Null implementation of the Iterator interface. More...

#include <IteratorHelpers.hpp>

Inheritance diagram for NullIterator< Item >:

Public Member Functions
void	first ()
void	next ()
bool	isDone ()
Item &	item ()
	~NullIterator ()
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::NullIterator< Item >

Null implementation of the Iterator interface.

This implementation merely iterates over nothing. It may be useful to use such an instance when we have to provide an Iterator instance but with nothing to iterate.

Constructor & Destructor Documentation

~NullIterator ( )

inline

Destructor.

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:

• /builds/workspace/publish-doc-api-gitlab/gatb-core/src/gatb/tools/designpattern/impl/IteratorHelpers.hpp