Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
PLMD::IFile Class Reference

#include <IFile.h>

Inheritance diagram for PLMD::IFile:
Inheritance graph
[legend]

Classes

class  Field
 

Public Member Functions

 IFile ()
 Constructor. More...
 
 ~IFile ()
 Destructor. More...
 
void allowIgnoredFields ()
 Allow some of the fields in the input to be ignored. More...
 
void allowNoEOL ()
 Allow files without EOL at the end. More...
 
void close ()
 Closes the file Should be used only for explicitely opened files. More...
 
FileBaseenforceSuffix (const std::string &suffix)
 Enforce suffix. More...
 
bool FieldExist (const std::string &s)
 Check if a field exist. More...
 
bool FileExist (const std::string &path)
 Check if the file exists. More...
 
virtual FileBaseflush ()
 Flushes the file to disk. More...
 
FILE * getFILE () const
 Get the underlying file pointer. More...
 
IFilegetline (std::string &)
 Get a full line as a string. More...
 
std::string getMode () const
 Retrieve the mode. More...
 
std::string getPath () const
 Retrieve the path. More...
 
std::string getSuffix () const
 Get the file suffix. More...
 
bool isOpen ()
 Check if a file is open. More...
 
FileBaselink (Action &)
 Link to an Action object. More...
 
FileBaselink (Communicator &)
 Link to a Communicator object. More...
 
FileBaselink (FILE *)
 Link to an already open filed. More...
 
FileBaselink (PlumedMain &)
 Link to a PlumedMain object Automatically links also the corresponding Communicator. More...
 
IFileopen (const std::string &name) override
 Opens the file. More...
 
 operator bool () const
 Check for error/eof. More...
 
void reset (bool)
 Reset end of file. More...
 
IFilescanField ()
 Ends a field-formatted line. More...
 
IFilescanField (const std::string &, double &)
 Read a double field. More...
 
IFilescanField (const std::string &, int &)
 Read a int field. More...
 
IFilescanField (const std::string &, long int &)
 Read a long int field. More...
 
IFilescanField (const std::string &, long unsigned &)
 Read a long unsigned field. More...
 
IFilescanField (const std::string &, std::string &)
 Read a string field. More...
 
IFilescanField (const std::string &, unsigned &)
 Read a unsigned field. More...
 
IFilescanField (Value *val)
 Read in a value. More...
 
IFilescanFieldList (std::vector< std::string > &)
 Gets the list of all fields. More...
 
void setHeavyFlush ()
 Set heavyFlush flag. More...
 

Static Public Member Functions

static std::string appendSuffix (const std::string &path, const std::string &suffix)
 Append suffix. More...
 

Protected Attributes

Actionaction
 pointer to corresponding action. NULL if not linked More...
 
bool cloned
 Control closing on destructor. More...
 
Communicatorcomm
 communicator. NULL if not set More...
 
bool eof
 Set to true when end of file is encountered. More...
 
bool err
 Set to true when error is encountered. More...
 
FILE * fp
 file pointer More...
 
void * gzfp
 zip file pointer. More...
 
bool heavyFlush
 Set to true if you want flush to be heavy (close/reopen) More...
 
std::string mode
 mode of the opened file More...
 
std::string path
 path of the opened file More...
 
PlumedMainplumed
 pointer to main plumed object. NULL if not linked More...
 

Private Member Functions

IFileadvanceField ()
 Advance to next field (= read one line) More...
 
unsigned findField (const std::string &name) const
 Find field index by name. More...
 
size_t llread (char *, size_t)
 Low-level read. More...
 

Private Attributes

std::string enforcedSuffix
 Enforced suffix: More...
 
bool enforcedSuffix_
 If true, use enforcedSuffix, else get it from PlumedMain. More...
 
std::vector< Fieldfields
 All the defined fields. More...
 
bool ignoreFields
 Set to true if you want to allow fields to be ignored in the read in file. More...
 
bool inMiddleOfField
 Flag set in the middle of a field reading. More...
 
bool noEOL
 Set to true to allow files without end-of-line at the end. More...
 

Detailed Description

Class for input files

This class provides features similar to those in the standard C "FILE*" type, but only for sequential input. See OFile for sequential output.

Constructor & Destructor Documentation

◆ IFile()

PLMD::IFile::IFile ( )

Constructor.

◆ ~IFile()

PLMD::IFile::~IFile ( )

Destructor.

Member Function Documentation

◆ advanceField()

IFile & PLMD::IFile::advanceField ( )
private

Advance to next field (= read one line)

◆ allowIgnoredFields()

void PLMD::IFile::allowIgnoredFields ( )

Allow some of the fields in the input to be ignored.

◆ allowNoEOL()

void PLMD::IFile::allowNoEOL ( )

Allow files without EOL at the end.

This in practice should be only used when opening plumed input files

◆ appendSuffix()

std::string PLMD::FileBase::appendSuffix ( const std::string &  path,
const std::string &  suffix 
)
staticinherited

Append suffix.

It appends the desired suffix to the string. Notice that it conserves some suffix (e.g. gz/xtc/trr).

◆ close()

void PLMD::FileBase::close ( )
inherited

Closes the file Should be used only for explicitely opened files.

◆ enforceSuffix()

FileBase & PLMD::FileBase::enforceSuffix ( const std::string &  suffix)
inherited

Enforce suffix.

Overrides the one set in PlumedMain&

◆ FieldExist()

bool PLMD::IFile::FieldExist ( const std::string &  s)

Check if a field exist.

◆ FileExist()

bool PLMD::FileBase::FileExist ( const std::string &  path)
inherited

Check if the file exists.

◆ findField()

unsigned PLMD::IFile::findField ( const std::string &  name) const
private

Find field index by name.

◆ flush()

FileBase & PLMD::FileBase::flush ( )
virtualinherited

Flushes the file to disk.

Reimplemented in PLMD::OFile.

◆ getFILE()

FILE * PLMD::FileBase::getFILE ( ) const
inlineinherited

Get the underlying file pointer.

It might be null even if the file is open, e.g. when the file was open as a gzipped file.

◆ getline()

IFile & PLMD::IFile::getline ( std::string &  str)

Get a full line as a string.

◆ getMode()

std::string PLMD::FileBase::getMode ( ) const
inlineinherited

Retrieve the mode.

◆ getPath()

std::string PLMD::FileBase::getPath ( ) const
inlineinherited

Retrieve the path.

◆ getSuffix()

std::string PLMD::FileBase::getSuffix ( ) const
inherited

Get the file suffix.

◆ isOpen()

bool PLMD::FileBase::isOpen ( )
inherited

Check if a file is open.

◆ link() [1/4]

FileBase & PLMD::FileBase::link ( Action action)
inherited

Link to an Action object.

Automatically links also the corresponding PlumedMain and Communicator.

◆ link() [2/4]

FileBase & PLMD::FileBase::link ( Communicator comm)
inherited

Link to a Communicator object.

◆ link() [3/4]

FileBase & PLMD::FileBase::link ( FILE *  fp)
inherited

Link to an already open filed.

◆ link() [4/4]

FileBase & PLMD::FileBase::link ( PlumedMain plumed)
inherited

Link to a PlumedMain object Automatically links also the corresponding Communicator.

◆ llread()

size_t PLMD::IFile::llread ( char *  ptr,
size_t  s 
)
private

Low-level read.

Note: in parallel, all processes read

◆ open()

IFile & PLMD::IFile::open ( const std::string &  name)
overridevirtual

Opens the file.

Implements PLMD::FileBase.

◆ operator bool()

PLMD::FileBase::operator bool ( ) const
inherited

Check for error/eof.

◆ reset()

void PLMD::IFile::reset ( bool  reset)

Reset end of file.

◆ scanField() [1/8]

IFile & PLMD::IFile::scanField ( )

Ends a field-formatted line.

Typically used as

  if.scanField("a",a).scanField("b",b).scanField();

◆ scanField() [2/8]

IFile & PLMD::IFile::scanField ( const std::string &  name,
double &  x 
)

Read a double field.

◆ scanField() [3/8]

IFile & PLMD::IFile::scanField ( const std::string &  name,
int &  x 
)

Read a int field.

◆ scanField() [4/8]

IFile & PLMD::IFile::scanField ( const std::string &  name,
long int &  x 
)

Read a long int field.

◆ scanField() [5/8]

IFile & PLMD::IFile::scanField ( const std::string &  name,
long unsigned &  x 
)

Read a long unsigned field.

◆ scanField() [6/8]

IFile & PLMD::IFile::scanField ( const std::string &  name,
std::string &  str 
)

Read a string field.

◆ scanField() [7/8]

IFile & PLMD::IFile::scanField ( const std::string &  name,
unsigned &  x 
)

Read a unsigned field.

◆ scanField() [8/8]

IFile & PLMD::IFile::scanField ( Value val)

Read in a value.

◆ scanFieldList()

IFile & PLMD::IFile::scanFieldList ( std::vector< std::string > &  s)

Gets the list of all fields.

◆ setHeavyFlush()

void PLMD::FileBase::setHeavyFlush ( )
inlineinherited

Set heavyFlush flag.

Member Data Documentation

◆ action

Action* PLMD::FileBase::action
protectedinherited

pointer to corresponding action. NULL if not linked

◆ cloned

bool PLMD::FileBase::cloned
protectedinherited

Control closing on destructor.

If true, file will not be closed in destructor

◆ comm

Communicator* PLMD::FileBase::comm
protectedinherited

communicator. NULL if not set

◆ enforcedSuffix

std::string PLMD::FileBase::enforcedSuffix
privateinherited

Enforced suffix:

◆ enforcedSuffix_

bool PLMD::FileBase::enforcedSuffix_
privateinherited

If true, use enforcedSuffix, else get it from PlumedMain.

◆ eof

bool PLMD::FileBase::eof
protectedinherited

Set to true when end of file is encountered.

◆ err

bool PLMD::FileBase::err
protectedinherited

Set to true when error is encountered.

◆ fields

std::vector<Field> PLMD::IFile::fields
private

All the defined fields.

◆ fp

FILE* PLMD::FileBase::fp
protectedinherited

file pointer

◆ gzfp

void* PLMD::FileBase::gzfp
protectedinherited

zip file pointer.

◆ heavyFlush

bool PLMD::FileBase::heavyFlush
protectedinherited

Set to true if you want flush to be heavy (close/reopen)

◆ ignoreFields

bool PLMD::IFile::ignoreFields
private

Set to true if you want to allow fields to be ignored in the read in file.

◆ inMiddleOfField

bool PLMD::IFile::inMiddleOfField
private

Flag set in the middle of a field reading.

◆ mode

std::string PLMD::FileBase::mode
protectedinherited

mode of the opened file

◆ noEOL

bool PLMD::IFile::noEOL
private

Set to true to allow files without end-of-line at the end.

◆ path

std::string PLMD::FileBase::path
protectedinherited

path of the opened file

◆ plumed

PlumedMain* PLMD::FileBase::plumed
protectedinherited

pointer to main plumed object. NULL if not linked


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