Opm::StreamLog Class Reference

#include <StreamLog.hpp>

Inheritance diagram for Opm::StreamLog:

Public Member Functions
	StreamLog (const std::string &logFile, int64_t messageMask, bool append=false)
	StreamLog (std::ostream &os, int64_t messageMask)
	~StreamLog ()
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

Protected Member Functions
virtual void	addMessageUnconditionally (int64_t messageType, 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

StreamLog() [1/2]

Opm::StreamLog::StreamLog	(	const std::string &	logFile,
		int64_t	messageMask,
		bool	append = false
	)

StreamLog() [2/2]

Opm::StreamLog::StreamLog	(	std::ostream &	os,
		int64_t	messageMask
	)

~StreamLog()

Opm::StreamLog::~StreamLog

(

)

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()

virtual void Opm::StreamLog::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.

Implements Opm::LogBackend.

Reimplemented in Opm::TimerLog, and Opm::EclipsePRTLog.

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.

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.

---

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

• StreamLog.hpp