##

FileLogger Class Reference
Common

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. More...
virtual | ~FileLogger ()
| Destructor. More...
std::string | GetLogDirectory () const
| Get the full path of the directory where all the log files are stored. More...
void | Init (const std::string &_prefix, const std::string &_filename)
| Initialize the file logger. More...
virtual FileLogger & | operator() ()
| Output a filename and line number, then return a reference to the logger. More...
virtual FileLogger & | operator() (const std::string &_file, int _line)
| Output a filename and line number, then return a reference to the logger. More...

## Detailed Description

A logger that outputs messages to a file.

## Constructor & Destructor Documentation

## FileLogger()

FileLogger | ( | const std::string & | _filename = `""` | ) |

explicit

Constructor.

Parameters

  [in] | _filename | Filename 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] | _prefix | Prefix added to the directory where the log file will be created.
  [in] | _filename | Name 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] | _file | Filename to output.
  [in] | _line | Line number in the _file.

Returns
  Reference to this logger.

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

- Console.hh