Class containing the log stream. More...

#include <Log.h>

Inheritance diagram for PLMD::Log:

Public Member Functions
OFile &	link (OFile &)
	Allows linking this OFile to another one. More...

FileBase &	link (FILE *)
	Allows overloading of link. More...

FileBase &	link (PlumedMain &)
	Allows overloading of link. More...

FileBase &	link (Communicator &)
	Allows overloading of link. More...

FileBase &	link (Action &)
	Allows overloading of link. More...

FileBase &	link (FILE *)
	Link to an already open filed. More...

FileBase &	link (PlumedMain &)
	Link to a PlumedMain object Automatically links also the corresponding Communicator. More...

FileBase &	link (Communicator &)
	Link to a Communicator object. More...

FileBase &	link (Action &)
	Link to an Action object. More...

void	setBackupString (const std::string &)
	Set the string name to be used for automatic backup. More...

void	backupFile (const std::string &bstring, const std::string &fname)
	Backup a file by giving it a different name. More...

void	backupAllFiles (const std::string &str)
	This backs up all the files that would have been created with the name str. More...

OFile &	open (const std::string &name)
	Opens the file using automatic append/backup. More...

virtual FileBase &	open (const std::string &name)=0
	Allows overloading of open. More...

OFile &	setLinePrefix (const std::string &)
	Set the prefix for output. More...

OFile &	fmtField (const std::string &)
	Set the format for writing double precision fields. More...

OFile &	fmtField ()
	Reset the format for writing double precision fields to its default. More...

OFile &	printField (const std::string &, double)
	Set the value of a double precision field. More...

OFile &	printField (const std::string &, int)
	Set the value of a int field. More...

OFile &	printField (const std::string &, const std::string &)
	Set the value of a string field. More...

OFile &	printField (Value *val, const double &v)
	Print a value. More...

OFile &	printField ()
	Close a line. More...

OFile &	addConstantField (const std::string &)

OFile &	setupPrintValue (Value *val)
	Used to setup printing of values. More...

OFile &	clearFields ()
	Resets the list of fields. More...

int	printf (const char *fmt,...)
	Formatted output with explicit format - a la printf. More...

OFile &	rewind ()
	Rewind a file. More...

virtual FileBase &	flush ()
	Flush a file. More...

OFile &	enforceRestart ()
	Enforce restart, also if the attached plumed object is not restarting. More...

OFile &	enforceBackup ()
	Enforce backup, even if the attached plumed object is restarting. More...

FileBase &	enforceSuffix (const std::string &suffix)
	Enforce suffix. More...

void	close ()
	Closes the file Should be used only for explicitely opened files. More...

	operator bool () const
	Check for error/eof. More...

void	setHeavyFlush ()
	Set heavyFlush flag. More...

bool	FileExist (const std::string &path)
	Check if the file exists. More...

bool	isOpen ()
	Check if a file is open. More...

std::string	getPath () const
	Retrieve the path. More...

std::string	getMode () const
	Retrieve the mode. More...

std::string	getSuffix () const
	Get the file suffix. More...

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

Protected Attributes
FILE *	fp
	file pointer More...

void *	gzfp
	zip file pointer. More...

Communicator *	comm
	communicator. NULL if not set More...

PlumedMain *	plumed
	pointer to main plumed object. NULL if not linked More...

Action *	action
	pointer to corresponding action. NULL if not linked More...

bool	cloned
	Control closing on destructor. More...

bool	eof
	Set to true when end of file is encountered. More...

bool	err
	Set to true when error is encountered. More...

std::string	path
	path of the opened file More...

std::string	mode
	mode of the opened file More...

bool	heavyFlush
	Set to true if you want flush to be heavy (close/reopen) More...

Detailed Description

Class containing the log stream.

It is similar to a FILE stream. It allows a printf() function, and also to write with a << operator. Moreover, it can prefix lines with the "PLUMED:" prefix, useful to grep out plumed log from output

Member Function Documentation

◆ addConstantField()

OFile & PLMD::OFile::addConstantField ( const std::string & name )

inherited

◆ 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).

◆ backupAllFiles()

void PLMD::OFile::backupAllFiles ( const std::string & str )

inherited

This backs up all the files that would have been created with the name str.

It is used in analysis when you are not restarting. Analysis output files at different times, which are names analysis.0.<filename>, analysis.1.<filename> and <filename>, are backed up to bck.0.analysis.0.<filename>, bck.0.analysis.1.<filename> and bck.0.<filename>

◆ backupFile()

void PLMD::OFile::backupFile	(	const std::string &	bstring,
		const std::string &	fname
	)

inherited

Backup a file by giving it a different name.

◆ clearFields()

OFile & PLMD::OFile::clearFields ( )

inherited

Resets the list of fields.

As it is only possible to add new constant fields (addConstantField()), this method can be used to clean the field list.

◆ close()

void PLMD::FileBase::close ( )

inherited

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

◆ enforceBackup()

OFile & PLMD::OFile::enforceBackup ( )

inherited

Enforce backup, even if the attached plumed object is restarting.

◆ enforceRestart()

OFile & PLMD::OFile::enforceRestart ( )

inherited

Enforce restart, also if the attached plumed object is not restarting.

Useful for tests

◆ enforceSuffix()

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

inherited

Enforce suffix.

Overrides the one set in PlumedMain&

◆ FileExist()

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

inherited

Check if the file exists.

◆ flush()

FileBase & PLMD::OFile::flush ( )

virtualinherited

Flush a file.

Reimplemented from PLMD::FileBase.

◆ fmtField() [1/2]

OFile & PLMD::OFile::fmtField ( const std::string & fmt )

inherited

Set the format for writing double precision fields.

◆ fmtField() [2/2]

OFile & PLMD::OFile::fmtField ( )

inherited

Reset the format for writing double precision fields to its default.

◆ 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/9]

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

inherited

Link to an already open filed.

◆ link() [2/9]

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

inherited

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

◆ link() [3/9]

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

inherited

Link to a Communicator object.

◆ link() [4/9]

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

inherited

Link to an Action object.

Automatically links also the corresponding PlumedMain and Communicator.

◆ link() [5/9]

FileBase & PLMD::FileBase::link

inherited

Allows overloading of link.

◆ link() [6/9]

FileBase & PLMD::FileBase::link

inherited

Allows overloading of link.

◆ link() [7/9]

FileBase & PLMD::FileBase::link

inherited

Allows overloading of link.

◆ link() [8/9]

FileBase & PLMD::FileBase::link

inherited

Allows overloading of link.

◆ link() [9/9]

OFile & PLMD::OFile::link ( OFile & l )

inherited

Allows linking this OFile to another one.

In this way, everything written to this OFile will be immediately written on the linked OFile. Notice that a OFile should be either opened explicitly, linked to a FILE or linked to a OFile

◆ open() [1/2]

virtual FileBase& PLMD::FileBase::open

inherited

Allows overloading of open.

◆ open() [2/2]

OFile & PLMD::OFile::open ( const std::string & name )

virtualinherited

Opens the file using automatic append/backup.

Implements PLMD::FileBase.

◆ operator bool()

PLMD::FileBase::operator bool ( ) const

inherited

Check for error/eof.

◆ printf()

int PLMD::OFile::printf	(	const char *	fmt,
			...
	)

inherited

Formatted output with explicit format - a la printf.

◆ printField() [1/5]

OFile & PLMD::OFile::printField	(	const std::string &	name,
		double	v
	)

inherited

Set the value of a double precision field.

◆ printField() [2/5]

OFile & PLMD::OFile::printField	(	const std::string &	name,
		int	v
	)

inherited

Set the value of a int field.

◆ printField() [3/5]

OFile & PLMD::OFile::printField	(	const std::string &	name,
		const std::string &	v
	)

inherited

Set the value of a string field.

◆ printField() [4/5]

OFile & PLMD::OFile::printField	(	Value *	val,
		const double &	v
	)

inherited

Print a value.

◆ printField() [5/5]

OFile & PLMD::OFile::printField ( )

inherited

Close a line.

Typically used as

  of.printField("a",a).printField("b",b).printField();

◆ rewind()

OFile & PLMD::OFile::rewind ( )

inherited

Rewind a file.

◆ setBackupString()

void PLMD::OFile::setBackupString ( const std::string & str )

inherited

Set the string name to be used for automatic backup.

◆ setHeavyFlush()

void PLMD::FileBase::setHeavyFlush ( )

inlineinherited

Set heavyFlush flag.

◆ setLinePrefix()

OFile & PLMD::OFile::setLinePrefix ( const std::string & l )

inherited

Set the prefix for output.

Typically "PLUMED: ". Notice that lines with a prefix cannot be parsed using fields in a IFile.

◆ setupPrintValue()

OFile & PLMD::OFile::setupPrintValue ( Value * val )

inherited

Used to setup printing of values.

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

◆ 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.

◆ 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)

◆ mode

std::string PLMD::FileBase::mode

protectedinherited

mode of the opened file

◆ 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 file:

tools/Log.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addConstantField()

◆ appendSuffix()

◆ backupAllFiles()

◆ backupFile()

◆ clearFields()

◆ close()

◆ enforceBackup()

◆ enforceRestart()

◆ enforceSuffix()

◆ FileExist()

◆ flush()

◆ fmtField() [1/2]

◆ fmtField() [2/2]

◆ getMode()

◆ getPath()

◆ getSuffix()

◆ isOpen()

◆ link() [1/9]

◆ link() [2/9]

◆ link() [3/9]

◆ link() [4/9]

◆ link() [5/9]

◆ link() [6/9]

◆ link() [7/9]

◆ link() [8/9]

◆ link() [9/9]

◆ open() [1/2]

◆ open() [2/2]

◆ operator bool()

◆ printf()

◆ printField() [1/5]

◆ printField() [2/5]

◆ printField() [3/5]

◆ printField() [4/5]

◆ printField() [5/5]

◆ rewind()

◆ setBackupString()

◆ setHeavyFlush()

◆ setLinePrefix()

◆ setupPrintValue()

Member Data Documentation

◆ action

◆ cloned

◆ comm

◆ eof

◆ err

◆ fp

◆ gzfp

◆ heavyFlush

◆ mode

◆ path

◆ plumed