esys::lsm::GeometryReader Class Reference

#include <GeometryReader.h>

Collaboration diagram for esys::lsm::GeometryReader:

Classes
class	Impl

Public Types
typedef ParticleReader::Iterator	ParticleIterator
typedef ConnectionReader::Iterator	ConnectionIterator

Public Member Functions
	GeometryReader (const std::string &fileName)
	GeometryReader (std::istream &iStream)
virtual	~GeometryReader ()
const std::string &	getFileName () const
const std::string &	getParticleType ()
const GeometryInfo &	getGeometryInfo () const
ParticleIterator &	getParticleIterator ()
ConnectionIterator &	getConnectionIterator ()

Protected Member Functions
void	initialise ()

Private Member Functions
	GeometryReader (const GeometryReader &geoReader)
GeometryReader &	operator= (const GeometryReader &geoReader) const

Private Attributes
Impl *	m_pImpl

Detailed Description

Objects of this class can be used to parse geometry (.geo) files generated by gengeo.

Member Typedef Documentation

ConnectionIterator

typedef ConnectionReader::Iterator esys::lsm::GeometryReader::ConnectionIterator

ParticleIterator

typedef ParticleReader::Iterator esys::lsm::GeometryReader::ParticleIterator

Constructor & Destructor Documentation

GeometryReader() [1/3]

esys::lsm::GeometryReader::GeometryReader

(

const std::string &

fileName

)

Initialises the reader. Reads file meta header-info.

Parameters

fileName

Name of geometry file.

Exceptions

std::runtime_error

if file does not exist or is an unsuitable format.

References esys::lsm::GeometryReader::Impl::initialise(), and m_pImpl.

Here is the call graph for this function:

GeometryReader() [2/3]

esys::lsm::GeometryReader::GeometryReader

(

std::istream &

iStream

)

Initialises the reader. Reads file meta header-info.

Parameters

iStream

Input stream from which geometry data is read.

Exceptions

std::runtime_error

if stream data is in an unsuitable format.

References esys::lsm::GeometryReader::Impl::initialise(), and m_pImpl.

Here is the call graph for this function:

~GeometryReader()

esys::lsm::GeometryReader::~GeometryReader ( )

virtual

References m_pImpl.

GeometryReader() [3/3]

esys::lsm::GeometryReader::GeometryReader ( const GeometryReader &  geoReader )

private

Member Function Documentation

getConnectionIterator()

GeometryReader::ConnectionIterator & esys::lsm::GeometryReader::getConnectionIterator

(

)

Returns iterator for enumerating particle-connection data from file.

References esys::lsm::GeometryReader::Impl::m_connectionReaderPtr, and m_pImpl.

Referenced by CLatticeMaster::readGeometry().

Here is the caller graph for this function:

getFileName()

const std::string & esys::lsm::GeometryReader::getFileName

(

)

const

Returns the name of the file associated with this geometry reader.

References esys::lsm::GeometryReader::Impl::m_fileName, and m_pImpl.

getGeometryInfo()

const GeometryInfo & esys::lsm::GeometryReader::getGeometryInfo

(

)

const

Returns a GeometryInfo object containing data associated with the file/stream of this reader.

References esys::lsm::GeometryReader::Impl::m_geoInfo, and m_pImpl.

Referenced by CLatticeMaster::readGeometry().

Here is the caller graph for this function:

getParticleIterator()

GeometryReader::ParticleIterator & esys::lsm::GeometryReader::getParticleIterator

(

)

Returns iterator for enumerating particle data from file.

References esys::lsm::GeometryReader::Impl::m_particleReaderPtr, and m_pImpl.

Referenced by CLatticeMaster::readGeometry().

Here is the caller graph for this function:

getParticleType()

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

(

)

Returns particle type as string.

References esys::lsm::GeometryReader::Impl::m_particleReaderPtr, and m_pImpl.

Referenced by CLatticeMaster::readGeometry().

Here is the caller graph for this function:

initialise()

void esys::lsm::GeometryReader::initialise ( )

protected

Reads/parses meta header-information from geometry file.

operator=()

GeometryReader& esys::lsm::GeometryReader::operator= ( const GeometryReader &  geoReader ) const

private

Member Data Documentation

m_pImpl

Impl* esys::lsm::GeometryReader::m_pImpl

private

Referenced by GeometryReader(), getConnectionIterator(), getFileName(), getGeometryInfo(), getParticleIterator(), getParticleType(), and ~GeometryReader().

---

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

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