UMPS::Logging::LogIt Class Reference

A wrapper to Earthworm's logit facility. If this library is not compiled against Earthworm then all calls will be written to stdout. More...

#include "umps/logging/logIt.hpp"

Inheritance diagram for UMPS::Logging::LogIt:

Collaboration diagram for UMPS::Logging::LogIt:

Public Member Functions
void	initialize (const std::string &programName, Level level=Level::INFO, int logFlag=1)
Level	getLevel () const noexcept override
void	error (const std::string &message) override
	Writes an error message. More...
void	warn (const std::string &message) override
	Writes a warning message. More...
void	info (const std::string &message) override
	Writes an info message. More...
void	debug (const std::string &message) override
	Writes a debug message. More...
	LogIt (const LogIt &)=delete
	LogIt (LogIt &&) noexcept=delete
LogIt &	operator= (const LogIt &)=delete
LogIt &	operator= (LogIt &&) noexcept=delete
Constructor
	LogIt ()
	Constructor.
	~LogIt () override
	Destructor.

Static Public Member Functions
static bool	haveEarthworm () noexcept

Detailed Description

A wrapper to Earthworm's logit facility. If this library is not compiled against Earthworm then all calls will be written to stdout.

Note

This class is a stub. As per usual, libew is a hot mess and there are missing functions during linking.

Member Function Documentation

debug()

void UMPS::Logging::LogIt::debug ( const std::string &  message )

overridevirtual

Writes a debug message.

Note

This requires getLevel() be >= Level::DEBUG.

Implements UMPS::Logging::ILog.

error()

void UMPS::Logging::LogIt::error ( const std::string &  message )

overridevirtual

Writes an error message.

Note

This requires getLevel() be >= Level::ERROR.

Implements UMPS::Logging::ILog.

getLevel()

Level UMPS::Logging::LogIt::getLevel ( ) const

overridevirtualnoexcept

Returns

Gets the logging level.

Implements UMPS::Logging::ILog.

haveEarthworm()

static bool UMPS::Logging::LogIt::haveEarthworm ( )

staticnoexcept

Returns

True indicates the library was compiled with earthworm.

info()

void UMPS::Logging::LogIt::info ( const std::string &  message )

overridevirtual

Writes an info message.

Note

This requires getLevel() be >= least Level::INFO.

Implements UMPS::Logging::ILog.

initialize()

void UMPS::Logging::LogIt::initialize	(	const std::string &	programName,
		Level	level = Level::INFO,
		int	logFlag = 1
	)

Parameters

[in]	programName	The program name. Earthworm will try to make log files from this and write to the EW_LOG environment variable directory.
[in]	level	Controls the log level.
[in]	logFlag	I have no idea. Some earthworm thing.

warn()

void UMPS::Logging::LogIt::warn ( const std::string &  message )

overridevirtual

Writes a warning message.

Note

This requires getLevel() be >= Level::WARN.

Implements UMPS::Logging::ILog.

---

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

• include/umps/logging/logIt.hpp