OpenWalnut  1.4.0
Classes | Public Member Functions | Private Member Functions | Private Attributes
WLoggerWrapper Class Reference

A wrapper for WLogger. More...

#include <WLoggerWrapper.h>

List of all members.

Classes

struct  FileStreamEntry
 A helper class for storing information about file streams that we added to the logger. More...

Public Member Functions

 WLoggerWrapper ()
 Constructor.
 WLoggerWrapper (WLogger *logger)
 Constructor.
 ~WLoggerWrapper ()
 Destructor.
bool addFileStream (std::string filename)
 Add a file to which the logger output will be written.
bool removeFileStream (std::string filename)
 Remove a file to which the logger writes.
void removeAllFileStreams ()
 Remove all files to which the logger writes (and which were added by this wrapper).

Private Member Functions

void removeFileStreamNumber (size_t i)
 Helper function that removes the file stream with the given index.

Private Attributes

WLoggerm_logger
 A pointer to the logger.
std::vector< FileStreamEntrym_fileStreamList
 List of file streams.

Detailed Description

A wrapper for WLogger.

This is used to expose a part of the WLogger functionality to script interpreters.

Definition at line 44 of file WLoggerWrapper.h.


Constructor & Destructor Documentation

Constructor.

Creates an empty wrapper.

Definition at line 35 of file WLoggerWrapper.cpp.

WLoggerWrapper::WLoggerWrapper ( WLogger logger) [explicit]

Constructor.

Parameters:
loggerA pointer to a logger instance.

Definition at line 39 of file WLoggerWrapper.cpp.

References m_logger.

Destructor.

Definition at line 45 of file WLoggerWrapper.cpp.

References removeAllFileStreams().


Member Function Documentation

bool WLoggerWrapper::addFileStream ( std::string  filename)

Add a file to which the logger output will be written.

Parameters:
filenameThe name of the file to write logging stuff into.
Returns:
true, if a stream to that file could be created and added successfully.

Definition at line 56 of file WLoggerWrapper.cpp.

References WLogger::addStream(), WLoggerWrapper::FileStreamEntry::m_filename, WLoggerWrapper::FileStreamEntry::m_fileStream, m_fileStreamList, m_logger, and WLoggerWrapper::FileStreamEntry::m_WLogStream.

Remove all files to which the logger writes (and which were added by this wrapper).

Definition at line 85 of file WLoggerWrapper.cpp.

References m_fileStreamList, and removeFileStreamNumber().

Referenced by ~WLoggerWrapper().

bool WLoggerWrapper::removeFileStream ( std::string  filename)

Remove a file to which the logger writes.

Parameters:
filenameThe name of the file to remove.
Returns:
true, if a stream to that file existed and was removed successfully.

Definition at line 72 of file WLoggerWrapper.cpp.

References m_fileStreamList, and removeFileStreamNumber().

Helper function that removes the file stream with the given index.

Parameters:
iThe index of the stream to remove.

Definition at line 50 of file WLoggerWrapper.cpp.

References m_fileStreamList, m_logger, and WLogger::removeStream().

Referenced by removeAllFileStreams(), and removeFileStream().


Member Data Documentation

List of file streams.

Definition at line 115 of file WLoggerWrapper.h.

Referenced by addFileStream(), removeAllFileStreams(), removeFileStream(), and removeFileStreamNumber().

A pointer to the logger.

Definition at line 112 of file WLoggerWrapper.h.

Referenced by addFileStream(), removeFileStreamNumber(), and WLoggerWrapper().


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