Doomwad::EventLog Class Reference

List of all members.

---

Detailed Description

Event logger class.

The event logger is a static class: you cannot instantiate it, use only its static methods. This ensures static storage is handled properly in terms of memory management, while giving a clean, object-oriented interface.

Simply use the SetStream method with a pointer to your logging stream, or use null to disable logging. Thanks to polymorphism, this stream could be standard output, standard error, a file, or even a string stream.

Once you assign a string, simply call the printLine() method. As its name implies, it adds a newline onto your output for you.

Definition at line 79 of file eventlog.hpp.

Static Public Member Functions
static bool	printLine (std::string &)
	Print a line to the output stream.
static bool	setStream (std::ostream *)
	Set output stream.
Private Member Functions
	EventLog (const EventLog &e) throw ()
	Copy constructor.
	EventLog () throw ()
	Default constructor.
void	operator= (const EventLog &e)
	Assignment operator.
	~EventLog () throw ()
	Destructor.
Static Private Attributes
static std::ostream *	out = NULL
	Output stream.

---

Constructor & Destructor Documentation

Doomwad::EventLog::EventLog (  const EventLog &  e  )  throw () [inline, private]

Copy constructor. Parameters: e  Original log. Definition at line 99 of file eventlog.hpp.

---

Member Function Documentation

void Doomwad::EventLog::operator= (  const EventLog &  e  )  [inline, private]

Assignment operator. Parameters: e  Original log. Definition at line 111 of file eventlog.hpp.

bool EventLog::printLine (  std::string &  str  )  [static]

Print a line to the output stream. Takes a string and prints it to the even log output stream. This function adds a newline, so you do not need to include it unless you want two line breaks. Parameters: str  String to output. Returns: True if the string was output. Definition at line 68 of file eventlog.cpp. References out. Referenced by Doomwad::Lump::append(), Doomwad::Lump::assign(), Doomwad::Lump::at(), Doomwad::Lump::getByte(), Doomwad::Lump::getDString(), Doomwad::Lump::getDWord(), Doomwad::Lump::getInt16(), Doomwad::Lump::getInt32(), Doomwad::Lump::getInt64(), Doomwad::Lump::getInt8(), Doomwad::Lump::getQWord(), Doomwad::Lump::getString(), Doomwad::Lump::getUInt16(), Doomwad::Lump::getUInt32(), Doomwad::Lump::getUInt64(), Doomwad::Lump::getUInt8(), Doomwad::Lump::getWord(), Doomwad::Lump::grow(), Doomwad::Lump::Lump(), Doomwad::Lump::operator+(), Doomwad::Lump::operator+=(), Doomwad::Lump::operator=(), Doomwad::Lump::readFromFile(), Doomwad::Lump::readFromStream(), Doomwad::Lump::setByte(), Doomwad::Lump::setDString(), Doomwad::Lump::setDWord(), Doomwad::Lump::setInt16(), Doomwad::Lump::setInt32(), Doomwad::Lump::setInt64(), Doomwad::Lump::setInt8(), Doomwad::Lump::setQWord(), Doomwad::Lump::setSize(), Doomwad::Lump::setString(), Doomwad::Lump::setUInt16(), Doomwad::Lump::setUInt32(), Doomwad::Lump::setUInt64(), Doomwad::Lump::setUInt8(), Doomwad::Lump::setWord(), Doomwad::Lump::shrink(), and Doomwad::Lump::writeToStream().

bool EventLog::setStream (  std::ostream *  stream  )  [static]

Set output stream. Parameters: stream  Pointer to the output stream, null for no output. Returns: True. Definition at line 51 of file eventlog.cpp. References out. Referenced by _fini(), and _init().

---