File data logger More...

Detailed Description

File data logger

Inheritance diagram for FileDataLogger:

Public Member Methods
	FileDataLogger ()
	Default constructor. More...

	FileDataLogger (PCChar8 baseFileName)
	Constructor. More...

void	SetBaseFileName (PCChar8 value)
	Set the base file name. More...

const String &	GetBaseFileName () const
	Gets the base file name . More...

String	GetCurrentFilePath () const
	Gets the logger file path. More...

void	SetMode (FileDataLoggerMode value)
	Set the logger mode. More...

FileDataLoggerMode	GetMode () const
	Gets the logger mode. More...

Public Member Methods inherited from BaseDataLogger
const bool &	GetIsEnabled () const
	Enable the logging. More...

const bool &	GetIsEnabled ()
	Enable the logging. More...

void	SetIsEnabled (const bool &value)
	Enable the logging. More...

const bool &	GetTimeStamped () const
	Enable the time stamping of the logged text. More...

const bool &	GetTimeStamped ()
	Enable the time stamping of the logged text. More...

void	SetTimeStamped (const bool &value)
	Enable the time stamping of the logged text. More...

void	Write (PCChar8 text)
	Writes a text. More...

void	WriteLine (PCChar8 text="")
	Writes a text and a new line. More...

void	Write (ISerializable &data)
	Writes the data of an ISerializable object. More...

void	WriteLine (ISerializable &data)
	Writes the data of an ISerializable object and a new line. More...

void	Write (PCChar8 text, ISerializable &data)
	Writes the data of an ISerializable object. More...

void	WriteLine (PCChar8 text, ISerializable &data)
	Writes the data of an ISerializable object and a new line. More...

Protected Member Functions
void	PerformWrite (PCChar8 text, ISerializable *data, bool newLine, bool timeStamp)
	Perform to write the logged message. More...

Protected Member Functions inherited from BaseDataLogger
void	LockedPerformWrite (PCChar8 text, ISerializable *data, bool newLine, bool timeStamp)
	Perform to write the logged message in a locked context. More...

Additional Inherited Members
Protected Attributes inherited from BaseDataLogger
CriticalSection	_criticalSection
	_criticalSection used to synchronize the writter with inner traitement mechanisms when needed. More...

Constructor & Destructor Documentation

FileDataLogger ( )

Default constructor.

Warning: SetBaseFileName() must be called before writing any text in order to give a name to the logger file.

FileDataLogger ( PCChar8 baseFileName )

Constructor.

Parameters

baseFileName Base file name. Extension does't matter. The base name may be extended depending on the FileDataLoggerMode.

const String& GetBaseFileName ( ) const

Gets the base file name .

String GetCurrentFilePath ( ) const

Gets the logger file path.

FileDataLoggerMode GetMode ( ) const

Gets the logger mode.

protectedvirtual

Perform to write the logged message.

Parameters

text	A text written before the data. (Can be NULL)
data	the data. (Can be NULL)
newLine	Write a new line at the end.
timeStamp	Write a time stamp at the beginning

This method implement the writing mechanism to the destination.

void SetBaseFileName ( PCChar8 value )

Set the base file name.

Parameters

value The base file name

Extension does't matter. The base name may be extended depending on the FileDataLoggerMode.

void SetMode ( FileDataLoggerMode value )

Set the logger mode.