TrueReality  v0.1.1912
trUtil::Logging::LogFile Class Reference

A log file. More...

#include <LogFile.h>

Static Public Member Functions

static void SetFileName (const std::string &name)
 Change the name of the log file (defaults to "TrueRealityLog.html") More...
 
static const std::string GetFileName ()
 Get the current filename of the log file. More...
 
static void SetTitle (const std::string &title)
 Change the title string used in HTML. More...
 
static const std::string & GetTitle ()
 Get the current HTML title string. More...
 

Static Public Attributes

static const std::string LOG_FILE_DEFAULT_NAME
 Log file default name. More...
 

Static Private Attributes

static std::string mLogFileName = LOG_FILE_DEFAULT_NAME
 
static std::string mTitle
 

Detailed Description

A log file.

Definition at line 49 of file LogFile.h.

Member Function Documentation

◆ GetFileName()

const std::string trUtil::Logging::LogFile::GetFileName ( )
static

Get the current filename of the log file.

Returns
The file name.

Definition at line 58 of file LogFile.cpp.

References mLogFileName.

Referenced by trUtil::Logging::LogWriterFile::OpenFile().

Here is the caller graph for this function:

◆ GetTitle()

const std::string & trUtil::Logging::LogFile::GetTitle ( )
static

Get the current HTML title string.

Returns
The title.

Definition at line 70 of file LogFile.cpp.

References mTitle.

Referenced by trUtil::Logging::LogWriterFile::OpenFile().

Here is the caller graph for this function:

◆ SetFileName()

void trUtil::Logging::LogFile::SetFileName ( const std::string &  name)
static

Change the name of the log file (defaults to "TrueRealityLog.html")

Parameters
nameThe name.

Definition at line 45 of file LogFile.cpp.

References trUtil::Logging::Log::GetInstance(), trUtil::Logging::Log::GetLogManagerRef(), mLogFileName, and trUtil::Logging::LogManager::ReOpenFile().

Referenced by trUtil::DefaultSettings::SetupLoggingOptions().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetTitle()

void trUtil::Logging::LogFile::SetTitle ( const std::string &  title)
static

Change the title string used in HTML.

Parameters
titleThe title.

Definition at line 64 of file LogFile.cpp.

References mTitle.

Member Data Documentation

◆ LOG_FILE_DEFAULT_NAME

const std::string trUtil::Logging::LogFile::LOG_FILE_DEFAULT_NAME
static

Log file default name.

Definition at line 53 of file LogFile.h.

◆ mLogFileName

std::string trUtil::Logging::LogFile::mLogFileName = LOG_FILE_DEFAULT_NAME
staticprivate

Definition at line 91 of file LogFile.h.

Referenced by GetFileName(), and SetFileName().

◆ mTitle

std::string trUtil::Logging::LogFile::mTitle
staticprivate

Definition at line 92 of file LogFile.h.

Referenced by GetTitle(), and SetTitle().


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