esys::lsm::ParticleReader Class Reference

#include <GeometryReader.h>

Inheritance diagram for esys::lsm::ParticleReader:

Collaboration diagram for esys::lsm::ParticleReader:

Public Member Functions
	ParticleReader (std::istream &iStream, bool is2d)
virtual void	initialise ()
const std::string &	getParticleType ()
Public Member Functions inherited from esys::lsm::IterativeReader< ParticleIterator >
	IterativeReader (std::istream &iStream)
virtual	~IterativeReader ()
int	getNumElements () const
bool	isInitialised () const
Iterator &	getIterator ()

Protected Member Functions
virtual ParticleIterator *	createNewIterator ()
Protected Member Functions inherited from esys::lsm::IterativeReader< ParticleIterator >
void	setNumElements (int numElements)
std::istream &	getIStream ()
const std::istream &	getIStream () const

Private Attributes
std::string	m_particleType
bool	m_is2d

Additional Inherited Members
Public Types inherited from esys::lsm::IterativeReader< ParticleIterator >
typedef ParticleIterator	Iterator
Protected Types inherited from esys::lsm::IterativeReader< ParticleIterator >
typedef std::auto_ptr< Iterator >	IteratorAutoPtr

Detailed Description

Creates iterator for parsing particle data from a stream.

Constructor & Destructor Documentation

ParticleReader()

esys::lsm::ParticleReader::ParticleReader	(	std::istream &	iStream,
		bool	is2d
	)

Constructs reader.

Member Function Documentation

createNewIterator()

ParticleIterator * esys::lsm::ParticleReader::createNewIterator ( )

protectedvirtual

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

Reimplemented from esys::lsm::IterativeReader< ParticleIterator >.

References esys::lsm::IterativeReader< ParticleIterator >::getIStream(), esys::lsm::IterativeReader< ParticleIterator >::getNumElements(), and m_is2d.

Here is the call graph for this function:

getParticleType()

const std::string & esys::lsm::ParticleReader::getParticleType

(

)

Returns particle type as string.

References initialise(), esys::lsm::IterativeReader< ParticleIterator >::isInitialised(), and m_particleType.

Here is the call graph for this function:

initialise()

void esys::lsm::ParticleReader::initialise ( )

virtual

Reads from iStream to determine the number of particles expected in the stream and constructs an iterator.

Reimplemented from esys::lsm::IterativeReader< ParticleIterator >.

References esys::lsm::IterativeReader< ParticleIterator >::getIStream(), esys::lsm::IterativeReader< TmplIterator >::initialise(), m_particleType, and esys::lsm::IterativeReader< ParticleIterator >::setNumElements().

Referenced by getParticleType().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_is2d

bool esys::lsm::ParticleReader::m_is2d

private

Referenced by createNewIterator().

m_particleType

std::string esys::lsm::ParticleReader::m_particleType

private

Referenced by getParticleType(), and initialise().

---

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

• Parallel/GeometryReader.h
• Parallel/GeometryReader.cpp