OpenM++ runtime library (libopenm)
openm::ILog Struct Referenceabstract

log public interface: log to console and into log files More...

Inheritance diagram for openm::ILog:
Collaboration diagram for openm::ILog:

Public Member Functions

virtual void logErr (const exception &i_ex, const char *i_msg=NULL) noexcept=0
 log exception
 
virtual void logSql (const char *i_sql) noexcept=0
 log sql query
 
virtual void init (bool i_logToConsole, const char *i_basePath, bool i_logToFile, bool i_useTimeStamp=false, bool i_usePidStamp=false, bool i_noMsgTime=false, bool i_isLogSql=false) noexcept=0
 re-initialize log file name(s) and other log settings. More...
 
virtual const string lastLogPath (void) noexcept=0
 if log to file enabled return "last" log file path. More...
 
virtual const string stampedLogPath (void) noexcept=0
 if log to "stamped" file enabled return "stamped" log file path. More...
 
virtual const string getMessage (const char *i_sourceMsg) noexcept=0
 get language-specific message by source non-translated message
 
virtual const list< string > getLanguages (void) noexcept=0
 get list of language name for the messages, eg: (en-ca, en)
 
virtual const unordered_map< string, string > getLanguageMessages (void) noexcept=0
 get copy of language-specific messages
 
virtual void swapLanguageMessages (const list< string > &i_langLst, unordered_map< string, string > &io_msgMap) noexcept=0
 set language-specific messages and update list of languages
 
- Public Member Functions inherited from openm::ILogBase
virtual void logMsg (const char *i_msg, const char *i_extra=NULL) noexcept=0
 log message
 
virtual void logFormatted (const char *i_format,...) noexcept=0
 log message formatted with vsnprintf()
 
virtual const string timeStamp (void) noexcept=0
 return timestamp part of log file name: 2012_08_17_16_04_59_148. More...
 

Detailed Description

log public interface: log to console and into log files

Member Function Documentation

◆ init()

virtual void openm::ILog::init ( bool  i_logToConsole,
const char *  i_basePath,
bool  i_logToFile,
bool  i_useTimeStamp = false,
bool  i_usePidStamp = false,
bool  i_noMsgTime = false,
bool  i_isLogSql = false 
)
pure virtualnoexcept

re-initialize log file name(s) and other log settings.

Parameters
[in]i_logToConsoleif true then log to console
[in]i_basePathpath to "last" log file, if NULL or empty "" then no log file
[in]i_logToFileif true then enable log to "last" file
[in]i_useTimeStampif true then use timestamp suffix in "stamped" file name
[in]i_usePidStampif true then use PID suffix in "stamped" file name
[in]i_noMsgTimeif true then not prefix log messages with date-time
[in]i_isLogSqlif true then log SQL into log file

Implemented in openm::Log.

◆ lastLogPath()

virtual const string openm::ILog::lastLogPath ( void  )
pure virtualnoexcept

if log to file enabled return "last" log file path.

Implemented in openm::Log.

◆ stampedLogPath()

virtual const string openm::ILog::stampedLogPath ( void  )
pure virtualnoexcept

if log to "stamped" file enabled return "stamped" log file path.

Implemented in openm::Log.


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