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

FileBase &	open (const std::string &name, const std::string &mode)
	Opens the file (without auto-backup) 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...

FileBase &	flush ()
	Flushes the file to disk. 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...

Static Public Member Functions
static void	test ()
	Runs a small testcase. More...

Protected Attributes
FILE *	fp
	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...

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

Definition at line 35 of file Log.h.

Member Function Documentation

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

inherited

Definition at line 120 of file OFile.cpp.

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>

Definition at line 222 of file OFile.cpp.

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

inherited

Backup a file by giving it a different name.

Definition at line 237 of file OFile.cpp.

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.

Definition at line 128 of file OFile.cpp.

void PLMD::FileBase::close ( )

inherited

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

Definition at line 140 of file FileBase.cpp.

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

inherited

Check if the file exists.

Definition at line 118 of file FileBase.cpp.

FileBase & PLMD::FileBase::flush ( )

inherited

Flushes the file to disk.

Definition at line 70 of file FileBase.cpp.

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

inherited

Set the format for writing double precision fields.

Definition at line 135 of file OFile.cpp.

OFile & PLMD::OFile::fmtField ( )

inherited

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

Definition at line 140 of file OFile.cpp.

bool PLMD::FileBase::isOpen ( )

inherited

Check if a file is open.

Definition at line 134 of file FileBase.cpp.

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

inherited

Link to an already open filed.

Definition at line 64 of file FileBase.cpp.

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

inherited

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

Definition at line 85 of file FileBase.cpp.

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

inherited

Link to a Communicator object.

Definition at line 79 of file FileBase.cpp.

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

inherited

Link to an Action object.

Automatically links also the corresponding PlumedMain and Communicator.

Definition at line 92 of file FileBase.cpp.

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

Definition at line 71 of file OFile.cpp.

FileBase & PLMD::FileBase::open	(	const std::string &	name,
		const std::string &	mode
	)

inherited

Opens the file (without auto-backup)

Definition at line 99 of file FileBase.cpp.

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

inherited

Opens the file using automatic append/backup.

Definition at line 264 of file OFile.cpp.

PLMD::FileBase::operator bool ( ) const

inherited

Check for error/eof.

Definition at line 166 of file FileBase.cpp.

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

inherited

Formatted output with explicit format - a la printf.

Definition at line 82 of file OFile.cpp.

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

inherited

Set the value of a double precision field.

Definition at line 145 of file OFile.cpp.

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

inherited

Set the value of a int field.

Definition at line 151 of file OFile.cpp.

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

inherited

Set the value of a string field.

Definition at line 157 of file OFile.cpp.

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

inherited

Print a value.

Definition at line 180 of file OFile.cpp.

OFile & PLMD::OFile::printField ( )

inherited

Close a line.

Typically used as

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

Definition at line 190 of file OFile.cpp.

OFile & PLMD::OFile::rewind ( )

inherited

Rewind a file.

Definition at line 284 of file OFile.cpp.

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

inherited

Set the string name to be used for automatic backup.

Definition at line 218 of file OFile.cpp.

void PLMD::FileBase::setHeavyFlush ( )

inlineinherited

Set heavyFlush flag.

Definition at line 101 of file FileBase.h.

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.

Definition at line 77 of file OFile.cpp.

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

inherited

Used to setup printing of values.

Definition at line 172 of file OFile.cpp.

void PLMD::FileBase::test ( )

staticinherited

Runs a small testcase.

Definition at line 37 of file FileBase.cpp.

Member Data Documentation

Action* PLMD::FileBase::action

protectedinherited

pointer to corresponding action. NULL if not linked

Definition at line 63 of file FileBase.h.

bool PLMD::FileBase::cloned

protectedinherited

Control closing on destructor.

If true, file will not be closed in destructor

Definition at line 66 of file FileBase.h.

Communicator* PLMD::FileBase::comm

protectedinherited

communicator. NULL if not set

Definition at line 59 of file FileBase.h.

bool PLMD::FileBase::eof

protectedinherited

Set to true when end of file is encountered.

Definition at line 71 of file FileBase.h.

bool PLMD::FileBase::err

protectedinherited

Set to true when error is encountered.

Definition at line 73 of file FileBase.h.

FILE* PLMD::FileBase::fp

protectedinherited

file pointer

Definition at line 57 of file FileBase.h.

bool PLMD::FileBase::heavyFlush

protectedinherited

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

Definition at line 77 of file FileBase.h.

std::string PLMD::FileBase::path

protectedinherited

path of the opened file

Definition at line 75 of file FileBase.h.

PlumedMain* PLMD::FileBase::plumed

protectedinherited

pointer to main plumed object. NULL if not linked

Definition at line 61 of file FileBase.h.

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

Member Data Documentation