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

---

ProtoMol::File Class Reference

#include <File.h>

Inheritance diagram for ProtoMol::File:

List of all members.

Public Member Functions
virtual	~File ()
void	setFilename (const std::string &filename)
std::string	getFilename () const
virtual bool	open ()=0
virtual bool	open (const std::string &filename)=0
virtual bool	open (const char *filename)=0
bool	isAccessible ()
void	close ()
	operator void * () const
bool	operator! () const
Protected Member Functions
	File (std::ios::openmode mode)
	File (std::ios::openmode mode, const std::string &filename)
std::fstream &	read (char *c, std::streamsize count)
std::string	getline ()
Protected Attributes
std::fstream	myFile
std::string	myFilename
std::string	myComment
Private Member Functions
	File ()
Private Attributes
std::ios::openmode	myMode

---

Detailed Description

Abstract base class for all I/O; readers and writers. The readers and writes are intend to act STL alike to stream into or from a supported structure or container.

NB:

• New writer or reader should never inherit directly from File, but from Reader or Writer.
• Reading binaries one should always use File::read(), rather directly myFile.read, since some compilers like Sun WorkShop CC have problems.
• Be careful when defining constructors or methods with default values; especially implicit conversion const char* to string
• File objects can be used as ios_base objects inside expression (e.g., while(dcdReader >> xyz){ ... } )

---

Constructor & Destructor Documentation

ProtoMol::File::File (   )  [inline, private]

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

ProtoMol::File::File (  std::ios::openmode  mode, const std::string &  filename )  [protected]

ProtoMol::File::~File (   )  [virtual]

---

Member Function Documentation

void ProtoMol::File::close (   )

std::string ProtoMol::File::getFilename (   )  const [inline]

std::string ProtoMol::File::getline (   )  [protected]

bool ProtoMol::File::isAccessible (   )

bool ProtoMol::File::open (  const char *  filename  )  [pure virtual]

Implemented in ProtoMol::ConfigurationReader, ProtoMol::DCDTrajectoryReader, ProtoMol::DCDTrajectoryWriter, ProtoMol::PARReader, ProtoMol::PARWriter, ProtoMol::PDBReader, ProtoMol::PDBWriter, ProtoMol::PGMReader, ProtoMol::PGMWriter, ProtoMol::PNGWriter, ProtoMol::PPMReader, ProtoMol::PPMWriter, ProtoMol::PSFReader, ProtoMol::PSFWriter, ProtoMol::XFigWriter, ProtoMol::XYZBinReader, ProtoMol::XYZBinWriter, ProtoMol::XYZReader, ProtoMol::XYZTrajectoryReader, ProtoMol::XYZTrajectoryWriter, ProtoMol::XYZWriter, ProtoMol::iSGPARReader, ProtoMol::TRANSReader, ProtoMol::XSCReader, and ProtoMol::XSCWriter.

virtual bool ProtoMol::File::open (  const std::string &  filename  )  [pure virtual]

Implemented in ProtoMol::ConfigurationReader, ProtoMol::DCDTrajectoryReader, ProtoMol::DCDTrajectoryWriter, ProtoMol::PARReader, ProtoMol::PARWriter, ProtoMol::PDBReader, ProtoMol::PDBWriter, ProtoMol::PGMReader, ProtoMol::PGMWriter, ProtoMol::PNGWriter, ProtoMol::PPMReader, ProtoMol::PPMWriter, ProtoMol::PSFReader, ProtoMol::PSFWriter, ProtoMol::XFigWriter, ProtoMol::XYZBinReader, ProtoMol::XYZBinWriter, ProtoMol::XYZReader, ProtoMol::XYZTrajectoryReader, ProtoMol::XYZTrajectoryWriter, ProtoMol::XYZWriter, ProtoMol::iSGPARReader, ProtoMol::TRANSReader, ProtoMol::XSCReader, and ProtoMol::XSCWriter.

bool ProtoMol::File::open (   )  [pure virtual]

Implemented in ProtoMol::ConfigurationReader, ProtoMol::DCDTrajectoryReader, ProtoMol::DCDTrajectoryWriter, ProtoMol::PARReader, ProtoMol::PARWriter, ProtoMol::PDBReader, ProtoMol::PDBWriter, ProtoMol::PGMReader, ProtoMol::PGMWriter, ProtoMol::PNGWriter, ProtoMol::PPMReader, ProtoMol::PPMWriter, ProtoMol::PSFReader, ProtoMol::PSFWriter, ProtoMol::XFigWriter, ProtoMol::XYZBinReader, ProtoMol::XYZBinWriter, ProtoMol::XYZReader, ProtoMol::XYZTrajectoryReader, ProtoMol::XYZTrajectoryWriter, ProtoMol::XYZWriter, ProtoMol::iSGPARReader, ProtoMol::TRANSReader, ProtoMol::XSCReader, and ProtoMol::XSCWriter.

ProtoMol::File::operator void * (   )  const

bool ProtoMol::File::operator! (   )  const

std::fstream & ProtoMol::File::read (  char *  c, std::streamsize  count )  [protected]

void ProtoMol::File::setFilename (  const std::string &  filename  )  [inline]

---

Member Data Documentation

std::string ProtoMol::File::myComment [protected]

std::fstream ProtoMol::File::myFile [protected]

std::string ProtoMol::File::myFilename [protected]

std::ios::openmode ProtoMol::File::myMode [private]

---

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

• File.h
• File.cpp

Last update: . GNU GENERAL PUBLIC LICENSE, copyrighted by the University of Notre Dame and the University of Bergen, Norway.