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

#include <IterativeReader.h>

Inheritance diagram for esys::lsm::IterativeReader< TmplIterator >:

Public Types
typedef TmplIterator	Iterator

Public Member Functions
	IterativeReader (std::istream &iStream)
virtual	~IterativeReader ()
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 ()

Private Attributes
int	m_numElements
std::istream *	m_pIStream
IteratorAutoPtr	m_iteratorPtr

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 Typedef Documentation

Iterator

template<class TmplIterator >

typedef TmplIterator esys::lsm::IterativeReader< TmplIterator >::Iterator

IteratorAutoPtr

template<class TmplIterator >

typedef std::auto_ptr<Iterator> esys::lsm::IterativeReader< TmplIterator >::IteratorAutoPtr

protected

Constructor & Destructor Documentation

IterativeReader()

template<class TmplIterator >

esys::lsm::IterativeReader< TmplIterator >::IterativeReader

(

std::istream &

iStream

)

~IterativeReader()

template<class TmplIterator >

esys::lsm::IterativeReader< TmplIterator >::~IterativeReader

virtual

Member Function Documentation

createNewIterator()

template<class TmplIterator >

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

protectedvirtual

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

Reimplemented in esys::lsm::ParticleReader.

getIStream() [1/2]

template<class TmplIterator >

std::istream & esys::lsm::IterativeReader< TmplIterator >::getIStream

protected

getIStream() [2/2]

template<class TmplIterator >

const std::istream & esys::lsm::IterativeReader< TmplIterator >::getIStream

protected

getIterator()

template<class TmplIterator >

IterativeReader< TmplIterator >::Iterator & esys::lsm::IterativeReader< TmplIterator >::getIterator

Referenced by Mesh2D::loadCheckPoint(), TriMesh::loadCheckPoint(), and esys::lsm::CheckPointLoader::loadInto().

Here is the caller graph for this function:

getNumElements()

template<class TmplIterator >

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

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

initialise()

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::TriReader, esys::lsm::NodeReader, esys::lsm::Edge2DReader, esys::lsm::Node2DReader, esys::lsm::ConnectionReader, esys::lsm::ParticleReader, esys::lsm::CheckPointLoader::ConnectionReader, and esys::lsm::CheckPointLoader::ParticleReader.

Referenced by esys::lsm::ParticleReader::initialise().

Here is the caller graph for this function:

isInitialised()

template<class TmplIterator >

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

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

setNumElements()

template<class TmplIterator >

void esys::lsm::IterativeReader< TmplIterator >::setNumElements ( int  numElements )

protected

Member Data Documentation

m_iteratorPtr

template<class TmplIterator >

IteratorAutoPtr esys::lsm::IterativeReader< TmplIterator >::m_iteratorPtr

private

m_numElements

template<class TmplIterator >

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

private

m_pIStream

template<class TmplIterator >

std::istream* esys::lsm::IterativeReader< TmplIterator >::m_pIStream

private

---

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

• Parallel/IterativeReader.h
• Parallel/IterativeReader.hpp