ProtoMol - an object-oriented component based framework for Molecular Dynamics simulations.

Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

ProtoMol::Reader Class Reference

#include <Reader.h>

Inheritance diagram for ProtoMol::Reader:

ProtoMol::File ProtoMol::ConfigurationReader ProtoMol::DCDTrajectoryReader ProtoMol::iSGPARReader ProtoMol::PARReader ProtoMol::PDBReader ProtoMol::PGMReader ProtoMol::PPMReader ProtoMol::PSFReader ProtoMol::TRANSReader ProtoMol::XSCReader ProtoMol::XYZBinReader ProtoMol::XYZReader ProtoMol::XYZTrajectoryReader List of all members.

Public Member Functions

virtual ~Reader ()
virtual bool tryFormat ()=0
virtual bool read ()=0
const std::string & getComment () const

Protected Member Functions

 Reader ()
 Reader (const std::string &filename)
 Reader (std::ios::openmode mode)
 Reader (std::ios::openmode mode, const std::string &filename)

Detailed Description

Base class of readers


Constructor & Destructor Documentation

ProtoMol::Reader::Reader  )  [protected]
 

ProtoMol::Reader::Reader const std::string &  filename  )  [explicit, protected]
 

ProtoMol::Reader::Reader std::ios::openmode  mode  )  [explicit, protected]
 

To open with special file flags, std::ios::in is set.

ProtoMol::Reader::Reader std::ios::openmode  mode,
const std::string &  filename
[protected]
 

To open with special file flags, std::ios::in is set.

ProtoMol::Reader::~Reader  )  [virtual]
 


Member Function Documentation

const string & ProtoMol::Reader::getComment  )  const
 

virtual bool ProtoMol::Reader::read  )  [pure virtual]
 

Simple test, true if it the format might be correct/readable.

Implemented in ProtoMol::ConfigurationReader, ProtoMol::DCDTrajectoryReader, ProtoMol::PARReader, ProtoMol::PDBReader, ProtoMol::PGMReader, ProtoMol::PPMReader, ProtoMol::PSFReader, ProtoMol::XYZBinReader, ProtoMol::XYZReader, ProtoMol::XYZTrajectoryReader, ProtoMol::iSGPARReader, ProtoMol::TRANSReader, and ProtoMol::XSCReader.

virtual bool ProtoMol::Reader::tryFormat  )  [pure virtual]
 

Implemented in ProtoMol::ConfigurationReader, ProtoMol::DCDTrajectoryReader, ProtoMol::PARReader, ProtoMol::PDBReader, ProtoMol::PGMReader, ProtoMol::PPMReader, ProtoMol::PSFReader, ProtoMol::XYZBinReader, ProtoMol::XYZReader, ProtoMol::XYZTrajectoryReader, ProtoMol::iSGPARReader, ProtoMol::TRANSReader, and ProtoMol::XSCReader.


The documentation for this class was generated from the following files: Last update: . GNU GENERAL PUBLIC LICENSE, copyrighted by the University of Notre Dame and the University of Bergen, Norway.