This class is the base for implementing ways to navigate over the band with spatial restriction, e.g. through a line, inside a bounding box or polygon, etc. More...

#include <PositionIterator.h>

Inheritance diagram for te::rst::AbstractPositionIterator< T >:

Public Member Functions
	AbstractPositionIterator ()
	Constructor. More...

	AbstractPositionIterator (const te::rst::Raster *r)
	Constructor. More...

	AbstractPositionIterator (const AbstractPositionIterator &rhs)
	Copy constructor. More...

virtual unsigned int	getColumn () const =0
	Returns the current column in iterator. More...

virtual unsigned int	getRow () const =0
	Returns the current row in iterator. More...

virtual bool	operator!= (const AbstractPositionIterator &rhs) const
	Difference operator. More...

virtual std::complex< T >	operator() (const unsigned int i) const =0
	Returns the complex value in current position (column, row, band) from iterator. More...

virtual const std::vector< T >	operator* () const =0
	Returns a vector of the values in current position (column, row) from iterator. More...

virtual void	operator++ ()=0
	Advances to the next position. More...

virtual void	operator-- ()=0
	Returns to the previous position. More...

AbstractPositionIterator &	operator= (const AbstractPositionIterator &rhs)
	Assignment operator. More...

virtual T	operator[] (const unsigned int i) const =0
	Returns the real value in current position (column, row, band) from iterator. More...

virtual void	setEnd ()=0
	Sets the iterator position to the end of the current band. More...

	~AbstractPositionIterator ()
	Destructor. More...

Protected Attributes
const te::rst::Raster *	m_raster
	The band from where to get the values. More...

Detailed Description

template<class T>
class te::rst::AbstractPositionIterator< T >

This class is the base for implementing ways to navigate over the band with spatial restriction, e.g. through a line, inside a bounding box or polygon, etc.

Definition at line 57 of file PositionIterator.h.

Constructor & Destructor Documentation

template<class T >

te::rst::AbstractPositionIterator< T >::AbstractPositionIterator ( )

Constructor.

Definition at line 379 of file PositionIterator.h.

template<class T >

te::rst::AbstractPositionIterator< T >::AbstractPositionIterator ( const te::rst::Raster * r )

Constructor.

Parameters

b	The band to iterate.

Definition at line 384 of file PositionIterator.h.

template<class T >

te::rst::AbstractPositionIterator< T >::AbstractPositionIterator ( const AbstractPositionIterator< T > & rhs )

Copy constructor.

Parameters

rhs	The right-hand-side copy used to copy from.

Definition at line 389 of file PositionIterator.h.

template<class T >

te::rst::AbstractPositionIterator< T >::~AbstractPositionIterator ( )

Destructor.

Definition at line 394 of file PositionIterator.h.

Member Function Documentation

template<class T>

virtual unsigned int te::rst::AbstractPositionIterator< T >::getColumn ( ) const

pure virtual

Returns the current column in iterator.

Implemented in te::rst::PointSetIterator< T >, te::rst::LineIterator< T >, and te::rst::PolygonIterator< T >.

template<class T>

virtual unsigned int te::rst::AbstractPositionIterator< T >::getRow ( ) const

pure virtual

Returns the current row in iterator.

Implemented in te::rst::PointSetIterator< T >, te::rst::LineIterator< T >, and te::rst::PolygonIterator< T >.

template<class T >

bool te::rst::AbstractPositionIterator< T >::operator!= ( const AbstractPositionIterator< T > & rhs ) const

virtual

Difference operator.

Parameters

rhs	The right-hand side to compare.

Returns: Returns true if the iterators are at different positions, or false otherwise.

Definition at line 406 of file PositionIterator.h.

References te::rst::AbstractPositionIterator< T >::m_raster.

template<class T>

virtual std::complex< T > te::rst::AbstractPositionIterator< T >::operator() ( const unsigned int i ) const

pure virtual

Returns the complex value in current position (column, row, band) from iterator.

Parameters

i	The band index.

Returns: The pixel comples value in current position.

Note: For real values use operator[]

Implemented in te::rst::PointSetIterator< T >, te::rst::LineIterator< T >, and te::rst::PolygonIterator< T >.

template<class T>

virtual const std::vector<T> te::rst::AbstractPositionIterator< T >::operator* ( ) const

pure virtual

Returns a vector of the values in current position (column, row) from iterator.

Implemented in te::rst::PointSetIterator< T >, te::rst::LineIterator< T >, and te::rst::PolygonIterator< T >.

template<class T>

virtual void te::rst::AbstractPositionIterator< T >::operator++ ( )

pure virtual

Advances to the next position.

Implemented in te::rst::PointSetIterator< T >, te::rst::LineIterator< T >, and te::rst::PolygonIterator< T >.

template<class T>

virtual void te::rst::AbstractPositionIterator< T >::operator-- ( )

pure virtual

Returns to the previous position.

Implemented in te::rst::PointSetIterator< T >, te::rst::LineIterator< T >, and te::rst::PolygonIterator< T >.

template<class T >

te::rst::AbstractPositionIterator< T > & te::rst::AbstractPositionIterator< T >::operator= ( const AbstractPositionIterator< T > & rhs )

Assignment operator.

Parameters

rhs	The right-hand-side copy used to copy from.

Returns: A reference to this object.

Definition at line 398 of file PositionIterator.h.

References te::rst::AbstractPositionIterator< T >::m_raster.

Referenced by te::rst::PolygonIterator< T >::operator=(), te::rst::LineIterator< T >::operator=(), and te::rst::PointSetIterator< T >::operator=().

template<class T>

virtual T te::rst::AbstractPositionIterator< T >::operator[] ( const unsigned int i ) const

pure virtual

Returns the real value in current position (column, row, band) from iterator.

Parameters

i	The band index.

Returns: The pixel real value in current position.

Note: For complex values use operator()

Implemented in te::rst::PointSetIterator< T >, te::rst::LineIterator< T >, and te::rst::PolygonIterator< T >.

template<class T>

virtual void te::rst::AbstractPositionIterator< T >::setEnd ( )

pure virtual

Sets the iterator position to the end of the current band.

Parameters

b	The band to retrieve the end information.

Implemented in te::rst::PointSetIterator< T >, te::rst::LineIterator< T >, and te::rst::PolygonIterator< T >.

Member Data Documentation

template<class T>

const te::rst::Raster* te::rst::AbstractPositionIterator< T >::m_raster

protected

The band from where to get the values.

Definition at line 145 of file PositionIterator.h.

Referenced by te::rst::LineIterator< T >::LineIterator(), te::rst::AbstractPositionIterator< T >::operator!=(), te::rst::AbstractPositionIterator< T >::operator=(), and te::rst::PointSetIterator< T >::PointSetIterator().

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

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/raster/PositionIterator.h

Public Member Functions

Protected Attributes

Detailed Description

template<class T> class te::rst::AbstractPositionIterator< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class te::rst::AbstractPositionIterator< T >