FileLogOutputter Class Reference

Write log to file. More...

#include <LogOutputters.h>

Inheritance diagram for FileLogOutputter:

Collaboration diagram for FileLogOutputter:

Public Member Functions
	FileLogOutputter (const char *logFile)
	~FileLogOutputter () override=default
void	open (const char *title) override
	Open the outputter.
void	close () override
	Close the outputter.
void	show (bool showIfEmpty) override
	Show the outputter.
bool	write (LogLevel level, const char *message) override
	Write a message with level.
void	setLogFilename (const char *title)
Public Member Functions inherited from ILogOutputter
Public Member Functions inherited from IInterface
virtual	~IInterface ()=default
	Interface destructor does nothing.

Detailed Description

Write log to file.

This outputter writes output to the file. The level for each message is ignored.

Constructor & Destructor Documentation

FileLogOutputter()

FileLogOutputter::FileLogOutputter ( const char * logFile )

explicit

~FileLogOutputter()

FileLogOutputter::~FileLogOutputter ( )

overridedefault

Member Function Documentation

close()

void FileLogOutputter::close ( )

overridevirtual

Close the outputter.

Close the outputter. Calling this method on an already closed outputter must have no effect.

Implements ILogOutputter.

open()

void FileLogOutputter::open ( const char * title )

overridevirtual

Open the outputter.

Opens the outputter for writing. Calling this method on an already open outputter must have no effect.

Implements ILogOutputter.

setLogFilename()

void FileLogOutputter::setLogFilename

(

const char *

title

)

show()

void FileLogOutputter::show ( bool showIfEmpty )

overridevirtual

Show the outputter.

Causes the output to become visible. This generally only makes sense for a logger in a graphical user interface. Other implementations will do nothing. Iff showIfEmpty is false then the implementation may optionally only show the log if it's not empty.

Implements ILogOutputter.

write()

bool FileLogOutputter::write ( LogLevel level, const char * message )

overridevirtual

Write a message with level.

Writes message, which has the given level, to a log. If this method returns true then Log will stop passing the message to all outputters in the outputter chain, otherwise it continues. Most implementations should return true.

Implements ILogOutputter.

---

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

• src/lib/base/LogOutputters.h
• src/lib/base/LogOutputters.cpp