Singleton-based logger for write only file-logging purposes. More...
#include <FileLogger.hpp>
Public Member Functions | |
| virtual | ~FileLogger () |
| Destructor for a FileLogger object. | |
| void | logMessage (const std::string &message) |
| Logs a string-message. | |
| void | setLogFile (const std::string &logFileName) |
| Specifies the file name of the logfile for the logger. | |
| void | closeLogFile () |
| Closes the current logfile (if it is open) | |
Static Public Member Functions | |
| static FileLogger & | getFileLogger () |
| Returns the only instance of the FileLogger class. | |
Private Member Functions | |
| FileLogger () | |
| Private constructor for the FileLogger class. | |
Private Attributes | |
| std::fstream | mFileStream |
| Filestream to the logfile. | |
| std::string | mFileName |
| The name of the logfile. | |
Detailed Description
Singleton-based logger for write only file-logging purposes.
Constructor & Destructor Documentation
| lama::FileLogger::~FileLogger | ( | ) | [virtual] |
Destructor for a FileLogger object.
References mFileStream.
| lama::FileLogger::FileLogger | ( | ) | [private] |
Private constructor for the FileLogger class.
In order to maintain singleton characteristics this constructor has to remain private
Member Function Documentation
| void lama::FileLogger::closeLogFile | ( | ) |
Closes the current logfile (if it is open)
References mFileName, and mFileStream.
| FileLogger & lama::FileLogger::getFileLogger | ( | ) | [static] |
Returns the only instance of the FileLogger class.
This static method returns always the same instance of the FileLogger class.
- Returns:
- The file logger
Referenced by lama::Logger::Logger(), and lama::Logger::logString().
| void lama::FileLogger::logMessage | ( | const std::string & | message | ) |
Logs a string-message.
- Parameters:
-
message The message which has to be logged
References mFileStream.
Referenced by lama::Logger::logString().
| void lama::FileLogger::setLogFile | ( | const std::string & | logFileName | ) |
Specifies the file name of the logfile for the logger.
- Parameters:
-
logFileName The name of the logfile
- Exceptions:
-
Throws an exception if the name already has been set and the caller tries to set it to a different name.
References LAMA_THROWEXCEPTION, mFileName, and mFileStream.
Referenced by lama::Logger::Logger().
Field Documentation
std::string lama::FileLogger::mFileName [private] |
The name of the logfile.
Referenced by closeLogFile(), and setLogFile().
std::fstream lama::FileLogger::mFileStream [private] |
Filestream to the logfile.
Referenced by closeLogFile(), logMessage(), setLogFile(), and ~FileLogger().
The documentation for this class was generated from the following files:
- /home/brandes/workspace/LAMA/src/lama/solver/logger/FileLogger.hpp
- /home/brandes/workspace/LAMA/src/lama/solver/logger/FileLogger.cpp
