Util::Log Class Reference

A static class that holds a log output stream. More...

#include <Log.h>

Static Public Member Functions
static void	initStatic ()
	Initialize static members. More...
static void	setFile (std::ofstream &file)
	Set the log ostream to a file. More...
static void	close ()
	Close log file, if any. More...
static std::ostream &	file ()
	Get log ostream by reference. More...

Detailed Description

A static class that holds a log output stream.

The Log class has one a static pointer member that points to an ostream that should be used by all other classes to output log and error messages. This stream is accessed by the file() method.

The log file initialized to point to std::cout. It may be reset to point to a ofstream file object using the static setFile() method.

Definition at line 30 of file Log.h.

Member Function Documentation

initStatic()

void Util::Log::initStatic ( )

static

Initialize static members.

Definition at line 23 of file Log.cpp.

Referenced by Util::initStatic().

setFile()

void Util::Log::setFile ( std::ofstream &  file )

static

Set the log ostream to a file.

Parameters

file	ofstream open for writing.

Definition at line 36 of file Log.cpp.

References file().

close()

void Util::Log::close ( )

static

Close log file, if any.

Definition at line 45 of file Log.cpp.

Referenced by Util::MpiThrow().

file()

std::ostream & Util::Log::file ( )

static

Get log ostream by reference.

Definition at line 57 of file Log.cpp.

Referenced by Pscf::SpaceGroup< D >::checkMeshDimensions(), Pscf::Pspc::FilmIteratorBase< D, IteratorType >::checkSpaceGroup(), Util::checkString(), Pscf::AmIteratorTmpl< Iterator, T >::clear(), Pscf::AmIteratorTmpl< Iterator, DArray< double > >::clear(), Pscf::Pspc::System< D >::compare(), Pscf::AmIteratorTmpl< Iterator, DArray< double > >::computeError(), Pscf::AmIteratorTmpl< Iterator, T >::computeError(), Pscf::Pspg::FieldIo< D >::convertKGridToBasis(), Pscf::Pspc::FieldIo< D >::convertKGridToBasis(), Pscf::Pspc::FieldIo< D >::convertRGridToBasis(), Util::Manager< Data >::endReadManager(), Util::Exception::Exception(), Util::XmlStartTag::finish(), Pscf::Pspc::FieldIo< D >::hasSymmetry(), Pscf::Fd1d::System::iterate(), Pscf::Pspc::System< D >::iterate(), Pscf::Pspg::System< D >::iterate(), Util::ParamComposite::load(), Util::Parameter::load(), Util::Factory< Data >::loadObject(), Util::ParamComposite::loadOptional(), Util::XmlEndTag::match(), Util::XmlStartTag::matchLabel(), Util::MpiThrow(), Pscf::Fd1d::System::readCommands(), Pscf::Pspc::System< D >::readCommands(), Pscf::Pspg::System< D >::readCommands(), Pscf::Pspc::FieldIo< D >::readFieldHeader(), Pscf::Pspg::FieldIo< D >::readFieldHeader(), Pscf::Pspc::FieldIo< D >::readFieldRGrid(), Pscf::Pspc::FieldIo< D >::readFieldsBasis(), Pscf::Pspg::FieldIo< D >::readFieldsBasis(), Pscf::Pspc::FieldIo< D >::readFieldsRGrid(), Pscf::readGroup(), Util::Factory< Data >::readObject(), Util::Begin::readParam(), Util::Blank::readParam(), Util::End::readParam(), Util::Parameter::readParam(), Pscf::Pspc::System< D >::readParameters(), Pscf::Pspg::System< D >::readParameters(), setFile(), Pscf::Pspc::FilmIterator< 1, IteratorType >::setFlexibleParams(), Pscf::Pspc::FilmIterator< 2, IteratorType >::setFlexibleParams(), Pscf::Pspc::FilmIterator< 3, IteratorType >::setFlexibleParams(), Pscf::Fd1d::System::setOptions(), Pscf::Pspc::System< D >::setOptions(), Pscf::Pspg::System< D >::setOptions(), Pscf::AmIteratorTmpl< Iterator, DArray< double > >::setup(), Pscf::Fd1d::BinaryRelaxIterator::solve(), Pscf::Fd1d::NrIterator::solve(), Pscf::Fd1d::System::sweep(), Pscf::Pspc::System< D >::sweep(), Pscf::Pspg::System< D >::sweep(), Pscf::Pspc::FieldIo< D >::writeFieldRGrid(), and Pscf::Pspc::FieldIo< D >::writeFieldsRGrid().

---

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

• Log.h
• Log.cpp