ESyS-Particle  4.0.1
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
esys::lsm::GeometryReader Class Reference

#include <GeometryReader.h>

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)
const std::string & getFileName () const
const std::string & getParticleType ()
const GeometryInfogetGeometryInfo () const
ParticleIteratorgetParticleIterator ()
ConnectionIteratorgetConnectionIterator ()

Protected Member Functions

void initialise ()

Detailed Description

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

Constructor & Destructor Documentation

esys::lsm::GeometryReader::GeometryReader ( const std::string &  fileName)

Initialises the reader. Reads file meta header-info.

Parameters
fileNameName of geometry file.
Exceptions
std::runtime_errorif file does not exist or is an unsuitable format.
esys::lsm::GeometryReader::GeometryReader ( std::istream &  iStream)

Initialises the reader. Reads file meta header-info.

Parameters
iStreamInput stream from which geometry data is read.
Exceptions
std::runtime_errorif stream data is in an unsuitable format.

Member Function Documentation

GeometryReader::ConnectionIterator & esys::lsm::GeometryReader::getConnectionIterator ( )

Returns iterator for enumerating particle-connection data from file.

Referenced by CLatticeMaster::readGeometry().

Here is the caller graph for this function:

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

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

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

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

Referenced by CLatticeMaster::readGeometry().

Here is the caller graph for this function:

GeometryReader::ParticleIterator & esys::lsm::GeometryReader::getParticleIterator ( )

Returns iterator for enumerating particle data from file.

Referenced by CLatticeMaster::readGeometry().

Here is the caller graph for this function:

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

Returns particle type as string.

Referenced by CLatticeMaster::readGeometry().

Here is the caller graph for this function:

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

Reads/parses meta header-information from geometry file.


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