Opm::TimerLog Class Reference

#include <TimerLog.hpp>

Inheritance diagram for Opm::TimerLog:

Public Member Functions
	TimerLog (const std::string &logFile)
	TimerLog (std::ostream &os)
void	clear ()
	~TimerLog ()
void	setMessageFormatter (std::shared_ptr< MessageFormatterInterface > formatter)
	Configure how formatMessage() will modify message strings. More...
void	setMessageLimiter (std::shared_ptr< MessageLimiter > limiter)
	Configure how message tags will be used to limit messages. More...
void	addMessage (int64_t messageFlag, const std::string &message)
	Add a message to the backend if accepted by the message limiter. More...
void	addTaggedMessage (int64_t messageFlag, const std::string &messageTag, const std::string &message)
	Add a tagged message to the backend if accepted by the message limiter. More...
int64_t	getMask () const

Static Public Attributes
static const int64_t	StartTimer = 4096
static const int64_t	StopTimer = 8192

Protected Member Functions
void	addMessageUnconditionally (int64_t messageFlag, const std::string &message) override
std::string	formatMessage (int64_t messageFlag, const std::string &message)
	Return decorated version of message depending on configureDecoration() arguments. More...

Constructor & Destructor Documentation

TimerLog() [1/2]

Opm::TimerLog::TimerLog ( const std::string &  logFile )

explicit

TimerLog() [2/2]

Opm::TimerLog::TimerLog ( std::ostream &  os )

explicit

~TimerLog()

Opm::TimerLog::~TimerLog ( )

inline

Member Function Documentation

addMessage()

void Opm::LogBackend::addMessage ( int64_t  messageFlag, const std::string &  message  )

inherited

Add a message to the backend if accepted by the message limiter.

addMessageUnconditionally()

void Opm::TimerLog::addMessageUnconditionally ( int64_t  messageFlag, const std::string &  message  )

overrideprotectedvirtual

This is the method subclasses should override.

Typically a subclass may filter, change, and output messages based on configuration and the messageFlag.

Reimplemented from Opm::StreamLog.

addTaggedMessage()

void Opm::LogBackend::addTaggedMessage ( int64_t  messageFlag, const std::string &  messageTag, const std::string &  message  )

inherited

Add a tagged message to the backend if accepted by the message limiter.

clear()

void Opm::TimerLog::clear

(

)

formatMessage()

std::string Opm::LogBackend::formatMessage ( int64_t  messageFlag, const std::string &  message  )

protectedinherited

Return decorated version of message depending on configureDecoration() arguments.

getMask()

int64_t Opm::LogBackend::getMask ( ) const

inherited

The message mask types are specified in the Opm::Log::MessageType namespace, in file LogUtils.hpp.

setMessageFormatter()

void Opm::LogBackend::setMessageFormatter ( std::shared_ptr< MessageFormatterInterface >  formatter )

inherited

Configure how formatMessage() will modify message strings.

setMessageLimiter()

void Opm::LogBackend::setMessageLimiter ( std::shared_ptr< MessageLimiter >  limiter )

inherited

Configure how message tags will be used to limit messages.

Member Data Documentation

StartTimer

const int64_t Opm::TimerLog::StartTimer = 4096

static

StopTimer

const int64_t Opm::TimerLog::StopTimer = 8192

static

---

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

• TimerLog.hpp