engine::Log Class Reference

Log class for writing debug/log data to files. More...

#include <Log.h>

Inheritance diagram for engine::Log:

List of all members.

Public Member Functions
bool	isDebugOutput () const
	Gets if debug output is enabled for this log.
	Log (const std::string &fileName)
	Log (const std::string &name, const std::string &fileName)
void	logMessage (const std::string &source, const std::string &text, LogLevel ll=LL_INFORMATION)
void	setDebugOutput (bool debugOutput=true)
	Sets debug output for this log.
	~Log ()
Protected Attributes
std::ofstream	mLogStream
Static Protected Attributes
static u32	msNextGeneratedLogIndex = 0
	Incremented count for next index.

---

Detailed Description

Log class for writing debug/log data to files.

---

Constructor & Destructor Documentation

engine::Log::Log

(

const std::string &

fileName

)

References mLogStream, engine::Object::mObjectType, and engine::OT_LOG.

engine::Log::Log	(	const std::string &	name,
		const std::string &	fileName
	)

References mLogStream, engine::Object::mObjectType, and engine::OT_LOG.

engine::Log::~Log

(

)

References mLogStream.

---

Member Function Documentation

bool engine::Log::isDebugOutput

(

)

const

Gets if debug output is enabled for this log.

void engine::Log::logMessage	(	const std::string &	source,
		const std::string &	text,
		LogLevel	ll = LL_INFORMATION
	)

Log a message a text into the log

Parameters:

source,:	The source form were this log is sent.
text,:	Text to print out.
ll,:	Log level of the text.

References engine::LL_ERROR, engine::LL_INFORMATION, engine::LL_WARNING, and mLogStream.

void engine::Log::setDebugOutput

(

bool

debugOutput = true

)

Sets debug output for this log.

---

Member Data Documentation

std::ofstream engine::Log::mLogStream [protected]

Referenced by Log(), logMessage(), and ~Log().

u32 engine::Log::msNextGeneratedLogIndex = 0 [static, protected]

Incremented count for next index.

---

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

• E:/Programming/MyProject/K_Game_hg/GameEngine/include/engine/Log.h
• E:/Programming/MyProject/K_Game_hg/GameEngine/src/engine/Log.cpp