esys::lsm::IterativeReader< TmplIterator > Class Template Reference

#include <IterativeReader.h>

List of all members.

Public Types
typedef TmplIterator	Iterator
Public Member Functions
	IterativeReader (std::istream &iStream)
virtual void	initialise ()
int	getNumElements () const
bool	isInitialised () const
Iterator &	getIterator ()
Protected Types
typedef std::auto_ptr< Iterator >	IteratorAutoPtr
Protected Member Functions
void	setNumElements (int numElements)
std::istream &	getIStream ()
const std::istream &	getIStream () const
virtual Iterator *	createNewIterator ()

---

Detailed Description

template<class TmplIterator>
class esys::lsm::IterativeReader< TmplIterator >

Template class which provides an iterator for reading multiple data-items from a stream.

Parameters:

TmplData

data class. The operator<<(std::istream &iStream, TmplData &data) operator is used to assign stream data inside the methods of the IterativeReader<TmplData>::Iterator class.

---

Member Function Documentation

template<class TmplIterator >

TmplIterator * esys::lsm::IterativeReader< TmplIterator >::createNewIterator

(

)

[protected, virtual]

Returns a new Iterator object. Caller of this method is to take ownership for the returned object.

Reimplemented in esys::lsm::ParticleReader.

template<class TmplIterator >

int esys::lsm::IterativeReader< TmplIterator >::getNumElements

(

)

const

Returns the number of elements to be read from the stream.

template<class TmplIterator >

void esys::lsm::IterativeReader< TmplIterator >::initialise

(

)

[virtual]

Creates the iterator using the istream and using the value returned by getNumElements.

Reimplemented in esys::lsm::ConnectionReader, esys::lsm::CheckPointLoader::ConnectionReader, esys::lsm::ParticleReader, esys::lsm::CheckPointLoader::ParticleReader, esys::lsm::Edge2DReader, esys::lsm::TriReader, esys::lsm::Node2DReader, and esys::lsm::NodeReader.

template<class TmplIterator >

bool esys::lsm::IterativeReader< TmplIterator >::isInitialised

(

)

const

Returns whether this reader is initialised, that is, whether an iterator has been created.

---

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

• IterativeReader.h
• IterativeReader.hpp