Ilwis-Objects  1.0
GIS and Remote Sensing framework for data access and processing
 All Classes Functions Enumerations Pages
Public Member Functions | List of all members
Ilwis::ItemIterator< T > Class Template Reference
Inheritance diagram for Ilwis::ItemIterator< T >:

Public Member Functions

 ItemIterator ()
 
 ItemIterator (const IlwisData< ItemDomain< T >> &dom, quint32 cur=0)
 
 ItemIterator (const ItemDomain< T > &dom, quint32 cur=0)
 
 ItemIterator (ItemRange *rng, quint32 cur=0)
 Constructs an ItemIterator from a SPItemRange and a currentposition. More...
 
 ItemIterator (const ItemIterator &iter)
 
ItemIteratoroperator= (const ItemIterator &iter)
 
ItemIteratoroperator++ ()
 
ItemIteratoroperator-- ()
 
ItemIteratoroperator+= (int n)
 
ItemIteratoroperator-= (int n)
 
ItemIteratoroperator< (const ItemIterator &iter)
 
ItemIteratoroperator> (const ItemIterator &iter)
 
ItemIteratoroperator<= (const ItemIterator &iter)
 
ItemIteratoroperator>= (const ItemIterator &iter)
 
T * operator* ()
 
ItemIterator operator++ (int)
 
ItemIterator operator-- (int)
 
ItemIteratoroperator[] (quint32 index)
 
bool operator== (const ItemIterator &iter) const
 
bool operator!= (const ItemIterator &iter) const
 
bool isValid ()
 
ItemIterator begin () const
 
ItemIterator end () const
 

Constructor & Destructor Documentation

template<typename T>
Ilwis::ItemIterator< T >::ItemIterator ( )
inline

Constructor for an empty ItemIterator

template<typename T>
Ilwis::ItemIterator< T >::ItemIterator ( const IlwisData< ItemDomain< T >> &  dom,
quint32  cur = 0 
)
inline

Constructs an ItemIterator from an ItemDomain and a current position
The itemdomain cannot be null and the position must be valid

Parameters
domthe ItemDomain in IlwisData form
curthe current position in this domain, default = 0
template<typename T>
Ilwis::ItemIterator< T >::ItemIterator ( const ItemDomain< T > &  dom,
quint32  cur = 0 
)
inline

Constructs an ItemIterator from an ItemDomain and a current possition
The itemdomain cannot be null and the position must be valid

Parameters
domThe ItemDomain
curThe current position in this domain, default = 0
template<typename T>
Ilwis::ItemIterator< T >::ItemIterator ( ItemRange rng,
quint32  cur = 0 
)
inline

Constructs an ItemIterator from a SPItemRange and a currentposition.

Parameters
rngThe SPItemrange
curThe current position in this range, default = 0
template<typename T>
Ilwis::ItemIterator< T >::ItemIterator ( const ItemIterator< T > &  iter)
inline

Copy Constructor

Parameters
iterItemIterator that should be copied

Member Function Documentation

template<typename T>
ItemIterator Ilwis::ItemIterator< T >::begin ( ) const
inline

Generates this ItemIterator at position 0

Returns
this at position 0
template<typename T>
ItemIterator Ilwis::ItemIterator< T >::end ( ) const
inline

Generates this ItemIterator at its last position

Returns
this at the last position
template<typename T>
bool Ilwis::ItemIterator< T >::isValid ( )
inline

Checks if this ItemIterator is valid

Returns
true when valid
template<typename T>
bool Ilwis::ItemIterator< T >::operator!= ( const ItemIterator< T > &  iter) const
inline

override of operator!= checks if this ItemIterator is equal to another only works if neither position is iUNDEF and the ranges are equal

Parameters
iterthe ItemIterator to compare to
Returns
true when the current position between the 2 is not equal (also false if the conditions are not met)
template<typename T>
T* Ilwis::ItemIterator< T >::operator* ( )
inline

override of operator *

Returns
template<typename T>
ItemIterator& Ilwis::ItemIterator< T >::operator++ ( )
inline

override of operator++ moves this ItemIterator by 1

Returns
this moved 1
template<typename T>
ItemIterator Ilwis::ItemIterator< T >::operator++ ( int  )
inline

override of operator++ moves this ItemIterator by 1

Returns
this moved 1
template<typename T>
ItemIterator& Ilwis::ItemIterator< T >::operator+= ( int  n)
inline

override of operator+= moves this ItemIterator by n

Parameters
nthe amount to move
Returns
this moved n
template<typename T>
ItemIterator& Ilwis::ItemIterator< T >::operator-- ( )
inline

override of operator– moves this ItemIterator by -1

Returns
this moved -1
template<typename T>
ItemIterator Ilwis::ItemIterator< T >::operator-- ( int  )
inline

override of operator– moves this ItemIterator by -1

Returns
this moved -1
template<typename T>
ItemIterator& Ilwis::ItemIterator< T >::operator-= ( int  n)
inline

override of operator-= moves this ItemIterator by 1

Parameters
nthe amount to move
Returns
this moved -n
template<typename T>
ItemIterator& Ilwis::ItemIterator< T >::operator< ( const ItemIterator< T > &  iter)
inline

override of operator< compares this ItemIterator with another based on the currentposition only works if both have the same range

Parameters
iterthe ItemIterator to compare with
Returns
true when this is smaller (also false when the ranges are not equal)
template<typename T>
ItemIterator& Ilwis::ItemIterator< T >::operator<= ( const ItemIterator< T > &  iter)
inline

override of operator<= compares this ItemIterator with another based on the currentposition only works if both have the same range

Parameters
iterthe ItemIterator to compare with
Returns
true when this is smaller or equal (also false when the ranges are not equal)
template<typename T>
ItemIterator& Ilwis::ItemIterator< T >::operator= ( const ItemIterator< T > &  iter)
inline

override of operator=

Copies the contents of the second ItemIterator to this one

Parameters
Theother ItemIterator
Returns
this iterator with the current and range of the other iterator
template<typename T>
bool Ilwis::ItemIterator< T >::operator== ( const ItemIterator< T > &  iter) const
inline

override of operator== checks if this ItemIterator is equal to another only works if neither position is iUNDEF and the ranges are equal

Parameters
iterthe ItemIterator to compare to
Returns
true when the current position between the 2 is equal (also false if the conditions are not met)
template<typename T>
ItemIterator& Ilwis::ItemIterator< T >::operator> ( const ItemIterator< T > &  iter)
inline

override of operator> compares this ItemIterator with another based on the currentposition only works if both have the same range

Parameters
iterthe ItemIterator to compare with
Returns
true when this is bigger (also false when the ranges are not equal)
template<typename T>
ItemIterator& Ilwis::ItemIterator< T >::operator>= ( const ItemIterator< T > &  iter)
inline

override of operator<= compares this ItemIterator with another based on the currentposition only works if both have the same range

Parameters
iterthe ItemIterator to compare with
Returns
true when this is bigger or equal (also false when the ranges are not equal)
template<typename T>
ItemIterator& Ilwis::ItemIterator< T >::operator[] ( quint32  index)
inline

override of operator[] gives this iterator at the index between brackets

Parameters
indexthe index
Returns
this at the given index

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