FileLogger Class Reference

A logger that outputs messages to a file. More...

#include <Console.hh>

Inherits ostream.

Classes

class  Buffer
 String buffer for the file logger. More...
 

Public Member Functions

 FileLogger (const std::string &_filename="")
 Constructor.
 
virtual ~FileLogger ()
 Destructor.
 
std::string GetLogDirectory () const
 Get the full path of the directory where all the log files are stored.
 
void Init (const std::string &_prefix, const std::string &_filename)
 Initialize the file logger.
 
virtual FileLoggeroperator() ()
 Output a filename and line number, then return a reference to the logger.
 
virtual FileLoggeroperator() (const std::string &_file, int _line)
 Output a filename and line number, then return a reference to the logger.
 

Detailed Description

A logger that outputs messages to a file.

Constructor & Destructor Documentation

◆ FileLogger()

FileLogger ( const std::string & _filename = "")
explicit

Constructor.

Parameters
[in]_filenameFilename to write into. If empty, FileLogger::Init must be called separately.

◆ ~FileLogger()

virtual ~FileLogger ( )
virtual

Destructor.

Member Function Documentation

◆ GetLogDirectory()

std::string GetLogDirectory ( ) const

Get the full path of the directory where all the log files are stored.

Returns
Full path of the directory.

◆ Init()

void Init ( const std::string & _prefix,
const std::string & _filename )

Initialize the file logger.

Parameters
[in]_prefixPrefix added to the directory where the log file will be created.
[in]_filenameName and path of the log file to write output into.

◆ operator()() [1/2]

virtual FileLogger & operator() ( )
virtual

Output a filename and line number, then return a reference to the logger.

Returns
Reference to this logger.

◆ operator()() [2/2]

virtual FileLogger & operator() ( const std::string & _file,
int _line )
virtual

Output a filename and line number, then return a reference to the logger.

Parameters
[in]_fileFilename to output.
[in]_lineLine number in the _file.
Returns
Reference to this logger.

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