Diarkis C++Client Library API Document
Public Member Functions | List of all members
FileLoggerBackend Class Reference

Class to output log to file. More...

#include <FileLoggerBackend.h>

Inheritance diagram for FileLoggerBackend:
Inheritance graph
[legend]
Collaboration diagram for FileLoggerBackend:
Collaboration graph
[legend]

Public Member Functions

 FileLoggerBackend (const Diarkis::StdString &logFilePath, bool bOutput)
 FileLoggerBackend Constructor. More...
 
virtual ~FileLoggerBackend ()
 FileLoggerBackend destructor. More...
 
virtual Result Log (const Diarkis::StdString &message, bool includeNewLine=true) override
 Outputs a log of specified messages. More...
 
virtual Result Log (const Diarkis::StdString &message, bool includeNewLine) override
 
- Public Member Functions inherited from StreamLoggerBackend
 StreamLoggerBackend (std::ostream &targetLog_)
 
 StreamLoggerBackend (StreamLoggerBackend &)=delete
 
 StreamLoggerBackend (StreamLoggerBackend &&)=delete
 
std::ostream & GetTargetLog () const
 

Detailed Description

Class to output log to file.

Constructor & Destructor Documentation

◆ FileLoggerBackend()

FileLoggerBackend::FileLoggerBackend ( const Diarkis::StdString &  logFilePath,
bool  bOutput 
)

FileLoggerBackend Constructor.

Parameters
[in]logFilePathFile path of log file to output
[in]bOutputtrue: output log to file false: output log to debug

◆ ~FileLoggerBackend()

FileLoggerBackend::~FileLoggerBackend ( )
virtual

FileLoggerBackend destructor.

Member Function Documentation

◆ Log() [1/2]

Result FileLoggerBackend::Log ( const Diarkis::StdString &  message,
bool  includeNewLine = true 
)
overridevirtual

Outputs a log of specified messages.

Parameters
[in]messageMessage to log output
[in]includeNewLineWhether to add a new line or not true=include

Reimplemented from StreamLoggerBackend.

Here is the call graph for this function:

◆ Log() [2/2]

Result StreamLoggerBackend::Log
override
The documentation for this class was generated from the following files: