trUtil::Logging::LogWriterFile Class Reference

A specialized LogWriter class that outputs Log messages to a file. More...

#include <LogWriterFile.h>

Inheritance diagram for trUtil::Logging::LogWriterFile:

Collaboration diagram for trUtil::Logging::LogWriterFile:

Public Member Functions
	LogWriterFile ()
	Default constructor. More...
void	OpenFile ()
	Opens the file. More...
virtual void	LogMessage (const LogData &logData)
	Logs a message. More...
void	LogHorizRule ()
	Logs horiz rule. More...
bool	IsOpenFailed ()
	Returns true if opening a file failed. More...
void	ResetOpenFail ()
	A utility function to reset the OpenFailed flag after a file failure. More...

Static Public Attributes
static const std::string	DEFAULT_LOG_FOLDER = std::string("/Logs")
	The folder path that is appended to the User Data folder (PathUtil::GetUserTCDataFolder()) More...

Protected Member Functions
virtual	~LogWriterFile ()
	Destructor. More...
Protected Member Functions inherited from trUtil::Logging::LogWriter
virtual	~LogWriter ()
	Destructor. More...

Private Member Functions
void	TimeTag (std::string prefix)
void	EndFile ()

Private Attributes
std::ofstream	mLogFile
bool	mOpenFailed

Detailed Description

A specialized LogWriter class that outputs Log messages to a file.

Definition at line 48 of file LogWriterFile.h.

Constructor & Destructor Documentation

LogWriterFile()

trUtil::Logging::LogWriterFile::LogWriterFile

(

)

Default constructor.

Definition at line 38 of file LogWriterFile.cpp.

~LogWriterFile()

trUtil::Logging::LogWriterFile::~LogWriterFile ( )

protectedvirtual

Destructor.

Definition at line 44 of file LogWriterFile.cpp.

References EndFile(), and mLogFile.

Here is the call graph for this function:

Member Function Documentation

EndFile()

void trUtil::Logging::LogWriterFile::EndFile ( )

private

Definition at line 53 of file LogWriterFile.cpp.

References mLogFile.

Referenced by OpenFile(), and ~LogWriterFile().

Here is the caller graph for this function:

IsOpenFailed()

bool trUtil::Logging::LogWriterFile::IsOpenFailed

(

)

Returns true if opening a file failed.

Returns

True if open failed, false if not.

Definition at line 230 of file LogWriterFile.cpp.

References mOpenFailed.

LogHorizRule()

void trUtil::Logging::LogWriterFile::LogHorizRule

(

)

Logs horiz rule.

Definition at line 219 of file LogWriterFile.cpp.

References mLogFile.

LogMessage()

void trUtil::Logging::LogWriterFile::LogMessage ( const LogData &  logData )

virtual

Logs a message.

Parameters

logData

Information describing the log.

Implements trUtil::Logging::LogWriter.

Definition at line 135 of file LogWriterFile.cpp.

References trUtil::Logging::LogWriter::LogData::file, trUtil::Logging::LogWriter::LogData::frameNumber, trUtil::Logging::Log::GetLogLevelString(), trUtil::Logging::LogWriter::LogData::line, trUtil::DateTime::TimeFormat::LOCAL_DATE_AND_TIME_FORMAT, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_WARNING, trUtil::Logging::LogWriter::LogData::logLevel, trUtil::Logging::LogWriter::LogData::logName, trUtil::Logging::LogWriter::LogData::method, mLogFile, trUtil::Logging::LogWriter::LogData::msg, OpenFile(), trUtil::Logging::LogWriter::LogData::time, and trUtil::DateTime::ToString().

Here is the call graph for this function:

OpenFile()

void trUtil::Logging::LogWriterFile::OpenFile

(

)

Opens the file.

Definition at line 60 of file LogWriterFile.cpp.

References DEFAULT_LOG_FOLDER, EndFile(), trUtil::Logging::LogFile::GetFileName(), trUtil::FileUtils::GetInstance(), trUtil::PathUtils::GetLogPath(), trUtil::Logging::LogFile::GetTitle(), trUtil::FileUtils::MakeDirectoryEX(), mLogFile, mOpenFailed, trUtil::FileUtils::PATH_SEPARATOR, and TimeTag().

Referenced by LogMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

ResetOpenFail()

void trUtil::Logging::LogWriterFile::ResetOpenFail

(

)

A utility function to reset the OpenFailed flag after a file failure.

Definition at line 244 of file LogWriterFile.cpp.

References mOpenFailed.

TimeTag()

void trUtil::Logging::LogWriterFile::TimeTag ( std::string  prefix )

private

Definition at line 126 of file LogWriterFile.cpp.

References trUtil::DateTime::TimeFormat::LOCAL_DATE_AND_TIME_FORMAT, mLogFile, trUtil::DateTime::SetToLocalTime(), and trUtil::DateTime::ToString().

Referenced by OpenFile().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

DEFAULT_LOG_FOLDER

const std::string trUtil::Logging::LogWriterFile::DEFAULT_LOG_FOLDER = std::string("/Logs")

static

The folder path that is appended to the User Data folder (PathUtil::GetUserTCDataFolder())

Definition at line 56 of file LogWriterFile.h.

Referenced by OpenFile().

mLogFile

std::ofstream trUtil::Logging::LogWriterFile::mLogFile

private

Definition at line 114 of file LogWriterFile.h.

Referenced by EndFile(), LogHorizRule(), LogMessage(), OpenFile(), TimeTag(), and ~LogWriterFile().

mOpenFailed

bool trUtil::Logging::LogWriterFile::mOpenFailed

private

Definition at line 115 of file LogWriterFile.h.

Referenced by IsOpenFailed(), OpenFile(), and ResetOpenFail().

---

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

• LogWriterFile.h
• LogWriterFile.cpp