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

trace log public interface: model event log to console and into log files More...

#include <omLog.h>

Inheritance diagram for openm::ITrace:
Collaboration diagram for openm::ITrace:

Public Member Functions

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) noexcept=0
 re-initialize log file name(s) and other log settings. More...
 
- Public Member Functions inherited from openm::ILogBase
virtual const bool isEnabled (void) noexcept=0
 return true if log to console or to file enabled More...
 
virtual void logMsg (const char *i_msg, const char *i_extra=NULL) noexcept=0
 log message More...
 
virtual void logFormatted (const char *i_format,...) noexcept=0
 log message formatted with vsnprintf() More...
 
virtual const std::string timeStamp (void) noexcept=0
 return timestamp part of log file name: 2012_08_17_16_04_59_148. More...
 
virtual void setRank (int i_rank, int i_worldSize) noexcept=0
 use process rank as log message prefix More...
 

Detailed Description

trace log public interface: model event log to console and into log files

Member Function Documentation

◆ init()

virtual void openm::ITrace::init ( bool  i_logToConsole,
const char *  i_basePath,
bool  i_logToFile,
bool  i_useTimeStamp = false,
bool  i_usePidStamp = false,
bool  i_noMsgTime = 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

Implemented in openm::TraceLog.


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