plb::global::PlbLogFile Class Reference

A globally accessible log file. More...

#include <plbLogFiles.h>

List of all members.

Public Member Functions
	PlbLogFile (std::string fName, bool parallel_)
	~PlbLogFile ()
void	push (std::string sectionName)
	Start a new section, with corresponding indentation.
void	pop ()
	End section, and unindent.
void	entry (std::string entryText)
	Write a log entry (endline is automatic).
void	flushEntry (std::string entryText)
	Write a log entry (endline is automatic) and flush the file buffer.
Friends
PlbLogFile &	logfile (std::string nameOfLogFile)
PlbLogFile &	logfile_nonparallel (std::string nameOfLogFile)

---

Detailed Description

A globally accessible log file.

---

Constructor & Destructor Documentation

plb::global::PlbLogFile::PlbLogFile	(	std::string	fName,
		bool	parallel_
	)

References plb::global::directories(), plb::global::mpi(), and plb::util::val2str().

plb::global::PlbLogFile::~PlbLogFile

(

)

---

Member Function Documentation

void plb::global::PlbLogFile::entry

(

std::string

entryText

)

Write a log entry (endline is automatic).

Referenced by push().

void plb::global::PlbLogFile::flushEntry

(

std::string

entryText

)

Write a log entry (endline is automatic) and flush the file buffer.

void plb::global::PlbLogFile::pop

(

)

End section, and unindent.

void plb::global::PlbLogFile::push

(

std::string

sectionName

)

Start a new section, with corresponding indentation.

References entry().

---

Friends And Related Function Documentation

PlbLogFile& logfile

(

std::string

nameOfLogFile

)

[friend]

PlbLogFile& logfile_nonparallel

(

std::string

nameOfLogFile

)

[friend]

---

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

• plbLogFiles.h
• plbLogFiles.cpp