RtIterator< T > Class Template Reference

Iterator class for RtLayout. More...

#include <CD_RtIterator.H>

Public Member Functions
	RtIterator ()=delete
	Empty constructor.
	RtIterator (RtLayout< T > &a_layout)
	Full constructor.
virtual	~RtIterator ()
	Destructor (does nothing)
virtual int	getNumberOfSolvers ()
	Get number of solvers.
virtual int	index () const
	Get current solver number/index.
virtual void	reset ()
	Reset iterator to first solver.
virtual bool	ok ()
	Check if we can cycle further through the solvers.
virtual void	operator++ ()
	Incrementation operator. Cycles to next solver.
virtual RefCountedPtr< T > &	operator() ()
	Get the solver pointed to by the iterator.
virtual RefCountedPtr< RtSpecies > &	getSpecies ()
	Get current species pointed to by the iterator.

Protected Attributes
int	m_isolver
	Solver currently pointed to.
int	m_num
	Number of solvers.
Vector< RefCountedPtr< T > >	m_solvers
	Ion solvers.
Vector< RefCountedPtr< RtSpecies > >	m_species
	Ions.

Detailed Description

template<class T>
class RtIterator< T >

Iterator class for RtLayout.

Constructor & Destructor Documentation

RtIterator()

template<class T >

RtIterator< T >::RtIterator

(

RtLayout< T > &

a_layout

)

Full constructor.

Iterator class for RtLayout.

Parameters

[in,out]

a_layout

Description

Member Function Documentation

getNumberOfSolvers()

template<class T >

int RtIterator< T >::getNumberOfSolvers ( )

virtual

Get number of solvers.

Returns

Number of solvers

getSpecies()

template<class T >

RefCountedPtr< RtSpecies > & RtIterator< T >::getSpecies ( )

virtual

Get current species pointed to by the iterator.

Returns

Species

index()

template<class T >

int RtIterator< T >::index ( ) const

virtual

Get current solver number/index.

Returns

Return value

ok()

template<class T >

bool RtIterator< T >::ok ( )

virtual

Check if we can cycle further through the solvers.

Returns

Return value

operator()()

template<class T >

RefCountedPtr< T > & RtIterator< T >::operator() ( )

virtual

Get the solver pointed to by the iterator.

Returns

Return value

---

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

• Source/RadiativeTransfer/CD_RtIterator.H
• Source/RadiativeTransfer/CD_RtIteratorImplem.H