OpenM++ runtime library (libopenm)
Loading...
Searching...
No Matches
openm::ILogBase Struct Referenceabstract

base for log public interface More...

#include <omLog.h>

Inheritance diagram for openm::ILogBase:

Public Member Functions

virtual const bool isEnabled (void) noexcept=0
 return true if log to console or to file enabled
 
virtual void logMsg (const char *i_msg, const char *i_extra=NULL) noexcept=0
 log message
 
virtual bool logFormatted (const char *i_format,...) noexcept=0
 log message formatted with vsnprintf()
 
virtual const std::string timeStamp (void) noexcept=0
 return timestamp part of log file name: 2012_08_17_16_04_59_148.
 
virtual void setRank (int i_rank, int i_worldSize) noexcept=0
 use process rank as log message prefix
 
virtual const bool isCreateError (void) noexcept=0
 error at file create of last log or stamped log file
 

Detailed Description

base for log public interface

Member Function Documentation

◆ isCreateError()

virtual const bool openm::ILogBase::isCreateError ( void  )
pure virtualnoexcept

error at file create of last log or stamped log file

Implemented in openm::LogBase.

◆ isEnabled()

virtual const bool openm::ILogBase::isEnabled ( void  )
pure virtualnoexcept

return true if log to console or to file enabled

Implemented in openm::LogBase.

◆ logFormatted()

virtual bool openm::ILogBase::logFormatted ( const char *  i_format,
  ... 
)
pure virtualnoexcept

log message formatted with vsnprintf()

Implemented in openm::Log, and openm::TraceLog.

◆ logMsg()

virtual void openm::ILogBase::logMsg ( const char *  i_msg,
const char *  i_extra = NULL 
)
pure virtualnoexcept

log message

Implemented in openm::Log, and openm::TraceLog.

◆ setRank()

virtual void openm::ILogBase::setRank ( int  i_rank,
int  i_worldSize 
)
pure virtualnoexcept

use process rank as log message prefix

Implemented in openm::LogBase.

◆ timeStamp()

virtual const std::string openm::ILogBase::timeStamp ( void  )
pure virtualnoexcept

return timestamp part of log file name: 2012_08_17_16_04_59_148.

it is never return empty "" string, even no log enabled or timestamp disabled for log file

Implemented in openm::LogBase.


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