PLMD::FileBase Class Reference

Base class for dealing with files. More...

#include <FileBase.h>

Inheritance diagram for PLMD::FileBase:

Classes
class	FieldBase
	Internal tool. More...

Public Member Functions
virtual	~FileBase ()
	Virtual destructor (allows inheritance)
void	close ()
	Closes the file Should be used only for explicitely opened files.
FileBase &	enforceSuffix (const std::string &suffix)
	Enforce suffix.
bool	FileExist (const std::string &path)
	Check if the file exists.
virtual FileBase &	flush ()
	Flushes the file to disk.
FILE *	getFILE () const
	Get the underlying file pointer.
std::string	getMode () const
	Retrieve the mode.
std::string	getPath () const
	Retrieve the path.
std::string	getSuffix () const
	Get the file suffix.
bool	isOpen ()
	Check if a file is open.
FileBase &	link (Action &)
	Link to an Action object.
FileBase &	link (Communicator &)
	Link to a Communicator object.
FileBase &	link (FILE *)
	Link to an already open filed.
FileBase &	link (PlumedMain &)
	Link to a PlumedMain object Automatically links also the corresponding Communicator.
virtual FileBase &	open (const std::string &name)=0
	Opens the file.
	operator bool () const
	Check for error/eof.
void	setHeavyFlush ()
	Set heavyFlush flag.

Static Public Member Functions
static std::string	appendSuffix (const std::string &path, const std::string &suffix)
	Append suffix.

Protected Member Functions
	FileBase ()
	Private constructor.

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

Private Member Functions
	FileBase (const FileBase &)=delete
	Copy constructor is disabled.
FileBase &	operator= (const FileBase &)=delete
	Assignment operator is disabled.

Private Attributes
std::string	enforcedSuffix
	Enforced suffix:
bool	enforcedSuffix_
	If true, use enforcedSuffix, else get it from PlumedMain.

Detailed Description

Base class for dealing with files.

This class just provides things which are common among OFile and IFile

Constructor & Destructor Documentation

FileBase() [1/2]

PLMD::FileBase::FileBase ( const FileBase & )

privatedelete

Copy constructor is disabled.

FileBase() [2/2]

PLMD::FileBase::FileBase ( )

protected

Private constructor.

In this manner one cannot instantiate a FileBase object

~FileBase()

PLMD::FileBase::~FileBase ( )

virtual

Virtual destructor (allows inheritance)

Member Function Documentation

appendSuffix()

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

static

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

(

)

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

enforceSuffix()

FileBase & PLMD::FileBase::enforceSuffix

(

const std::string &

suffix

)

Enforce suffix.

Overrides the one set in PlumedMain&

FileExist()

bool PLMD::FileBase::FileExist

(

const std::string &

path

)

Check if the file exists.

flush()

FileBase & PLMD::FileBase::flush ( )

virtual

Flushes the file to disk.

Reimplemented in PLMD::OFile.

getFILE()

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

inline

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.

getMode()

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

inline

Retrieve the mode.

getPath()

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

inline

Retrieve the path.

getSuffix()

std::string PLMD::FileBase::getSuffix

(

)

const

Get the file suffix.

isOpen()

bool PLMD::FileBase::isOpen

(

)

Check if a file is open.

link() [1/4]

FileBase & PLMD::FileBase::link

(

Action &

action

)

Link to an Action object.

Automatically links also the corresponding PlumedMain and Communicator.

link() [2/4]

FileBase & PLMD::FileBase::link

(

Communicator &

comm

)

Link to a Communicator object.

link() [3/4]

FileBase & PLMD::FileBase::link

(

FILE *

fp

)

Link to an already open filed.

link() [4/4]

FileBase & PLMD::FileBase::link

(

PlumedMain &

plumed

)

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

open()

virtual FileBase & PLMD::FileBase::open ( const std::string & name )

pure virtual

Opens the file.

Implemented in PLMD::IFile, and PLMD::OFile.

operator bool()

PLMD::FileBase::operator bool

(

)

const

Check for error/eof.

operator=()

FileBase & PLMD::FileBase::operator= ( const FileBase & )

privatedelete

Assignment operator is disabled.

setHeavyFlush()

void PLMD::FileBase::setHeavyFlush ( )

inline

Set heavyFlush flag.

Member Data Documentation

action

Action* PLMD::FileBase::action

protected

pointer to corresponding action. NULL if not linked

cloned

bool PLMD::FileBase::cloned

protected

Control closing on destructor.

If true, file will not be closed in destructor

comm

Communicator* PLMD::FileBase::comm

protected

communicator. NULL if not set

enforcedSuffix

std::string PLMD::FileBase::enforcedSuffix

private

Enforced suffix:

enforcedSuffix_

bool PLMD::FileBase::enforcedSuffix_

private

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

eof

bool PLMD::FileBase::eof

protected

Set to true when end of file is encountered.

err

bool PLMD::FileBase::err

protected

Set to true when error is encountered.

fp

FILE* PLMD::FileBase::fp

protected

file pointer

gzfp

void* PLMD::FileBase::gzfp

protected

zip file pointer.

heavyFlush

bool PLMD::FileBase::heavyFlush

protected

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

mode

std::string PLMD::FileBase::mode

protected

mode of the opened file

path

std::string PLMD::FileBase::path

protected

path of the opened file

plumed

PlumedMain* PLMD::FileBase::plumed

protected

pointer to main plumed object. NULL if not linked

---

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

• tools/FileBase.h
• tools/FileBase.cpp