version 3.3

VRS::Iterator< T > Class Template Reference

#include <vrs/container/iterator.h>

Inheritance diagram for VRS::Iterator< T >:

VRS::SharedObj VRS::Visitable VRS::SequenceContainerIteratorSTL< T, std::deque< T > > VRS::SequenceContainerIteratorSTL< T, std::vector< T > > VRS::ConstantIterator< T > VRS::DataIterator< T > VRS::FixedSizeIterator< T > VRS::GuardedCastIterator< TO, FROM > VRS::IndexedIterator< T, INDEX > VRS::LinearIterator< T > VRS::NonPersistentDataIterator< T > VRS::NonPersistentFixedSizeIterator< T > VRS::RepeatIterator< T > VRS::ReplicateIterator< T > VRS::ReverseIterator< T > VRS::SequenceContainerIteratorSTL< T, STL_CONTAINER > VRS::SkipIterator< T > VRS::StaticArrayIterator< T > VRS::SubIterator< T > VRS::SubIterator2D< T >

List of all members.

Public Types

typedef IteratorAdapterSTL< T > const_iterator

Public Member Functions

virtual unsigned int size () const =0
 Returns the number of elements, this iterator can iterate over.
virtual T get (unsigned int i) const =0
 Returns the i-th element of the elements described by this iterator.
virtual const T * pointer () const
virtual SharedObjcontainer () const
const_iterator beginSTL () const
 Returns an iterator that can be used for STL algorithms.
const_iterator endSTL () const
 Returns an iterator that can be used for STL algorithms.
 VRS_TYPEINFO (Iterator, SharedObj)


Detailed Description

template<typename T>
class VRS::Iterator< T >

Abstract base class for a random access iterator. An `Iterator' provides a uniform interface for iterating over elements of type `T'. An `Iterator' is used to traverse any kind of data container.

Member Typedef Documentation

template<typename T>
typedef IteratorAdapterSTL<T> VRS::Iterator< T >::const_iterator


Member Function Documentation

template<typename T>
virtual unsigned int VRS::Iterator< T >::size (  )  const [pure virtual]

template<typename T>
virtual T VRS::Iterator< T >::get ( unsigned int  i  )  const [pure virtual]

template<typename T>
virtual const T* VRS::Iterator< T >::pointer (  )  const [inline, virtual]

If this iterator points to a sequence of elements which is layed out in memory as a standard C++ array this method returns a pointer to the first element of this sequence; a null pointer otherwise (which is the default implementation of this method).

Reimplemented in VRS::ArrayIterator< T >, VRS::DataIterator< T >, VRS::FixedSizeIterator< T >, VRS::StaticArrayIterator< T >, VRS::SubIterator< T >, VRS::DataIterator< unsigned int >, VRS::DataIterator< VRS::SO< VRS::MipmapTexture2DGL::ImageProxy > >, VRS::DataIterator< VRS::SceneThing::ObjectType >, and VRS::DataIterator< VRS::SO< VRS::SharedObj > >.

template<typename T>
virtual SharedObj* VRS::Iterator< T >::container (  )  const [inline, virtual]

Returns the container this iterator belongs to. This method can return NULL, if the iterator does not belong to a container (e.g. ConstantIterator<T>).

Reimplemented in VRS::SequenceContainerIteratorSTL< T, STL_CONTAINER >, VRS::StaticArrayIterator< T >, VRS::SequenceContainerIteratorSTL< T, std::vector< T > >, and VRS::SequenceContainerIteratorSTL< T, std::deque< T > >.

template<typename T>
const_iterator VRS::Iterator< T >::beginSTL (  )  const [inline]

Returns an iterator that can be used for STL algorithms.

template<typename T>
const_iterator VRS::Iterator< T >::endSTL (  )  const [inline]

Returns an iterator that can be used for STL algorithms.

template<typename T>
VRS::Iterator< T >::VRS_TYPEINFO ( Iterator< T >  ,
SharedObj   
)


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

Generated on Mon May 21 06:00:16 2012 by Doxygen 1.5.6
© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact