#include <MsgHandler.h>

Inheritance diagram for MsgHandler:

Collaboration diagram for MsgHandler:

Public Types
enum class	MsgType { MT_MESSAGE , MT_WARNING , MT_ERROR , MT_DEBUG , MT_GLDEBUG }

Public Member Functions
virtual void	addRetriever (OutputDevice *retriever)
	Adds a further retriever to the instance responsible for a certain msg type.

virtual void	beginProcessMsg (std::string msg, bool addType=true)
	Begins a process information.

virtual void	clear (bool resetInformed=true)
	Clears information whether an error occurred previously and print aggregated message summary.

virtual void	endProcessMsg (std::string msg)
	Ends a process information.

virtual void	endProcessMsg2 (bool success, long duration=-1)
	Ends a process information with predefined messages.

virtual void	inform (std::string msg, bool addType=true)
	adds a new error to the list

template<typename T , typename... Targs>
void	informf (const std::string &format, T value, Targs... Fargs)
	adds a new formatted message

bool	isRetriever (OutputDevice *retriever) const
	Returns whether the given output device retrieves messages from the handler.

template<class T >
MsgHandler &	operator<< (const T &t)
	Generic output operator.

virtual void	removeRetriever (OutputDevice *retriever)
	Removes the retriever from the handler.

bool	wasInformed () const
	Returns the information whether any messages were added.

Static Public Member Functions
static void	cleanupOnEnd ()
	Removes pending handler.

static void	enableDebugGLMessages (bool enable)
	enable/disable gl-debug messages

static void	enableDebugMessages (bool enable)
	enable/disable debug messages

static MsgHandler *	getDebugInstance ()
	Returns the instance to add debug to.

static MsgHandler *	getErrorInstance ()
	Returns the instance to add errors to.

static MsgHandler *	getGLDebugInstance ()
	Returns the instance to add GLdebug to.

static MsgHandler *	getMessageInstance ()
	Returns the instance to add normal messages to.

static MsgHandler *	getWarningInstance ()
	Returns the instance to add warnings to.

static void	initOutputOptions ()
	init output options

static std::string	insertLineBreaks (std::string msg, int lineWidth)
	reformats a long string to contain newline after a certain line length in px (depending on the current font)

static void	removeRetrieverFromAllInstances (OutputDevice *out)
	ensure that that given output device is no longer used as retriever by any instance

static void	setFactory (Factory func)
	Sets the factory function to use for new MsgHandlers.

static void	setupI18n (const std::string &locale="")
	set up gettext stuff

static bool	writeDebugGLMessages ()
	check whether to enable/disable gl-debug messages

static bool	writeDebugMessages ()
	check whether to enable/disable debug messages

Protected Member Functions
virtual bool	aggregationThresholdReached (const std::string &format)

std::string	build (const std::string &msg, bool addType)
	Builds the string which includes the mml-message type.

std::string	buildProcessIdPrefix (void) const

std::string	buildTimestampPrefix (void) const

	MsgHandler (MsgType type)
	standard constructor

void	setAggregationThreshold (const int thresh)

virtual	~MsgHandler ()
	destructor

Private Types
typedef MsgHandler (	Factory) (MsgType)

Private Member Functions
	MsgHandler (const MsgHandler &s)=delete
	invalid copy constructor

MsgHandler &	operator= (const MsgHandler &s)=delete
	invalid assignment operator

Private Attributes
std::map< const std::string, int >	myAggregationCount
	count for messages of the same type

int	myAggregationThreshold
	do not output more messages of the same type if the count exceeds this threshold

std::vector< std::string >	myInitialMessages
	storage for initial messages

std::vector< OutputDevice * >	myRetrievers
	The list of retrievers that shall be informed about new messages or errors.

MsgType	myType
	The type of the instance.

bool	myWasInformed
	information whether an output occurred at all

Static Private Attributes
static bool	myAmProcessingProcess = false
	Information whether a process information is printed to cout.

static MsgHandler *	myDebugInstance = nullptr
	The instance to handle debug.

static MsgHandler *	myErrorInstance = nullptr
	The instance to handle errors.

static std::string	myErrorPrefix = "Error: "
	The possibly translated error prefix (mainly for speedup)

static Factory	myFactory = nullptr
	The function to call for new MsgHandlers, nullptr means use default constructor.

static MsgHandler *	myGLDebugInstance = nullptr
	The instance to handle glDebug.

static MsgHandler *	myMessageInstance = nullptr
	The instance to handle normal messages.

static MsgHandler *	myWarningInstance = nullptr
	The instance to handle warnings.

static std::string	myWarningPrefix = "Warning: "
	The possibly translated warning prefix (mainly for speedup)

static bool	myWriteDebugGLMessages = false
	Flag to enable or disable GL specific debug output.

static bool	myWriteDebugMessages = false
	Flag to enable or disable debug output.

static bool	myWriteProcessId = false
	Whether to prefix every message with the process id.

static bool	myWriteTimestamps = false
	Whether to prefix every message with a time stamp.

Detailed Description

MsgHandler

Definition at line 39 of file MsgHandler.h.

Member Typedef Documentation

◆ Factory

typedef MsgHandler *(* MsgHandler::Factory) (MsgType)

private

Definition at line 60 of file MsgHandler.h.

Member Enumeration Documentation

◆ MsgType

enum class MsgHandler::MsgType

strong

An enumeration to differ between different types of messages (errors, warning and information)

Enumerator
MT_MESSAGE	The message is only something to show.
MT_WARNING	The message is a warning.
MT_ERROR	The message is an error.
MT_DEBUG	The message is debug output.
MT_GLDEBUG	The message is GL debug output.

Definition at line 46 of file MsgHandler.h.

Constructor & Destructor Documentation

◆ MsgHandler() [1/2]

MsgHandler::MsgHandler ( MsgType type )

protected

standard constructor

Definition at line 401 of file MsgHandler.cpp.

References addRetriever(), OutputDevice::getDevice(), and MT_MESSAGE.

◆ ~MsgHandler()

MsgHandler::~MsgHandler ( )

protectedvirtual

destructor

Definition at line 411 of file MsgHandler.cpp.

◆ MsgHandler() [2/2]

MsgHandler::MsgHandler ( const MsgHandler & s )

privatedelete

invalid copy constructor

Member Function Documentation

◆ addRetriever()

void MsgHandler::addRetriever ( OutputDevice * retriever )

virtual

Adds a further retriever to the instance responsible for a certain msg type.

Reimplemented in MsgHandlerSynchronized.

Definition at line 237 of file MsgHandler.cpp.

References isRetriever(), and myRetrievers.

Referenced by MsgHandlerSynchronized::addRetriever(), GNELoadThread::GNELoadThread(), GUILoadThread::GUILoadThread(), GUIRunThread::init(), initOutputOptions(), MsgHandler(), GUIMessageWindow::registerMsgHandlers(), GUILoadThread::run(), and GNELoadThread::run().

Here is the caller graph for this function:

◆ aggregationThresholdReached()

virtual bool MsgHandler::aggregationThresholdReached ( const std::string & format )

inlineprotectedvirtual

Reimplemented in MsgHandlerSynchronized.

Definition at line 207 of file MsgHandler.h.

References myAggregationCount, and myAggregationThreshold.

Referenced by MsgHandlerSynchronized::aggregationThresholdReached(), and informf().

Here is the caller graph for this function:

◆ beginProcessMsg()

void MsgHandler::beginProcessMsg	(	std::string	msg,
		bool	addType = `true`
	)

virtual

Begins a process information.

When a longer action is started, this method should be used to inform the user about it. There will be no newline printed, but the message handler will be informed that a process message has been begun. If an error occurs, a newline will be printed. After the action has been performed, use endProcessMsg to inform the user about it.

Reimplemented in MsgHandlerSynchronized.

Definition at line 174 of file MsgHandler.cpp.

References build(), myAmProcessingProcess, myRetrievers, and myWasInformed.

Referenced by MsgHandlerSynchronized::beginProcessMsg().

Here is the caller graph for this function:

◆ build()

std::string MsgHandler::build	(	const std::string &	msg,
		bool	addType
	)

inlineprotected

Builds the string which includes the mml-message type.

Definition at line 176 of file MsgHandler.h.

References buildProcessIdPrefix(), buildTimestampPrefix(), MT_DEBUG, MT_ERROR, MT_GLDEBUG, MT_MESSAGE, MT_WARNING, myErrorPrefix, myType, myWarningPrefix, myWriteProcessId, and myWriteTimestamps.

Referenced by beginProcessMsg(), and inform().

Here is the caller graph for this function:

◆ buildProcessIdPrefix()

std::string MsgHandler::buildProcessIdPrefix ( void ) const

protected

Definition at line 388 of file MsgHandler.cpp.

Referenced by build().

Here is the caller graph for this function:

◆ buildTimestampPrefix()

std::string MsgHandler::buildTimestampPrefix ( void ) const

protected

Definition at line 374 of file MsgHandler.cpp.

Referenced by build().

Here is the caller graph for this function:

◆ cleanupOnEnd()

void MsgHandler::cleanupOnEnd ( )

static

Removes pending handler.

Definition at line 359 of file MsgHandler.cpp.

References myDebugInstance, myErrorInstance, myGLDebugInstance, myMessageInstance, and myWarningInstance.

Referenced by SystemFrame::close(), GUIRunThread::deleteSim(), main(), and setFactory().

Here is the caller graph for this function:

◆ clear()

void MsgHandler::clear ( bool resetInformed = true )

virtual

Clears information whether an error occurred previously and print aggregated message summary.

Reimplemented in MsgHandlerSynchronized.

Definition at line 213 of file MsgHandler.cpp.

References inform(), myAggregationCount, myAggregationThreshold, myInitialMessages, myWasInformed, toString(), and wasInformed().

Referenced by MsgHandlerSynchronized::clear(), SystemFrame::close(), GUIRunThread::deleteSim(), NLBuilder::init(), loadJTRDefinitions(), main(), NBLoadedTLDef::myCompute(), GUILoadThread::run(), GNELoadThread::run(), and XMLSubSys::runParser().

Here is the caller graph for this function:

◆ enableDebugGLMessages()

void MsgHandler::enableDebugGLMessages ( bool enable )

static

enable/disable gl-debug messages

Definition at line 124 of file MsgHandler.cpp.

References myWriteDebugGLMessages.

Referenced by GNEOptionsDialogElements::InputBool::onCmdSetOption(), and GNELoadThread::run().

Here is the caller graph for this function:

◆ enableDebugMessages()

void MsgHandler::enableDebugMessages ( bool enable )

static

enable/disable debug messages

Definition at line 119 of file MsgHandler.cpp.

References myWriteDebugMessages.

Referenced by GNEOptionsDialogElements::InputBool::onCmdSetOption(), and GNELoadThread::run().

Here is the caller graph for this function:

◆ endProcessMsg()

void MsgHandler::endProcessMsg ( std::string msg )

virtual

Ends a process information.

Reimplemented in MsgHandlerSynchronized.

Definition at line 201 of file MsgHandler.cpp.

References myAmProcessingProcess, myRetrievers, and myWasInformed.

Referenced by CHBuilder< E, V >::buildContractionHierarchy(), MsgHandlerSynchronized::endProcessMsg(), endProcessMsg2(), and NBHeightMapper::loadIfSet().

Here is the caller graph for this function:

◆ endProcessMsg2()

void MsgHandler::endProcessMsg2	(	bool	success,
		long	duration = `-1`
	)

virtual

Ends a process information with predefined messages.

Definition at line 187 of file MsgHandler.cpp.

References endProcessMsg(), TL, TLF, and toString().

◆ getDebugInstance()

MsgHandler * MsgHandler::getDebugInstance ( )

static

Returns the instance to add debug to.

Definition at line 101 of file MsgHandler.cpp.

References MT_DEBUG, and myDebugInstance.

Referenced by GUIMessageWindow::registerMsgHandlers(), GNELoadThread::run(), GNELoadThread::submitEndAndCleanup(), and GUIMessageWindow::unregisterMsgHandlers().

Here is the caller graph for this function:

◆ getErrorInstance()

MsgHandler * MsgHandler::getErrorInstance ( )

static

Returns the instance to add errors to.

Definition at line 92 of file MsgHandler.cpp.

References MT_ERROR, and myErrorInstance.

Referenced by NLHandler::addPhase(), MSRouteHandler::addStop(), NLBuilder::build(), MSSOTLTrafficLightLogic::checkPhases(), OutputDevice::closeAll(), RORouteHandler::closeFlow(), RORouteHandler::closeVehicle(), ROJTRRouter::compute(), GUIRunThread::deleteSim(), GNELoadThread::GNELoadThread(), GUILoadThread::GUILoadThread(), NLBuilder::init(), GUIRunThread::init(), initOutputOptions(), RORoute::isValid(), NIImporter_OpenStreetMap::load(), PCLoaderOSM::loadIfSet(), loadJTRDefinitions(), NIImporter_ArcView::loadNetwork(), MSNet::loadState(), main(), main(), GUIRunThread::makeStep(), ROLoader::openRoutes(), RORouteDef::preComputeCurrentRoute(), ROLoader::processRoutes(), GUIMessageWindow::registerMsgHandlers(), RORouteDef::repairCurrentRoute(), GUILoadThread::run(), GNELoadThread::run(), XMLSubSys::runParser(), RONet::saveAndRemoveRoutesUntil(), MSSOTLTrafficLightLogic::setToATargetPhase(), GNELoadThread::submitEndAndCleanup(), GUILoadThread::submitEndAndCleanup(), and GUIMessageWindow::unregisterMsgHandlers().

Here is the caller graph for this function:

◆ getGLDebugInstance()

MsgHandler * MsgHandler::getGLDebugInstance ( )

static

Returns the instance to add GLdebug to.

Definition at line 110 of file MsgHandler.cpp.

References MT_GLDEBUG, and myGLDebugInstance.

Referenced by GUIMessageWindow::registerMsgHandlers(), GNELoadThread::run(), GNELoadThread::submitEndAndCleanup(), and GUIMessageWindow::unregisterMsgHandlers().

Here is the caller graph for this function:

◆ getMessageInstance()

MsgHandler * MsgHandler::getMessageInstance ( )

static

Returns the instance to add normal messages to.

Definition at line 66 of file MsgHandler.cpp.

References MT_MESSAGE, myFactory, and myMessageInstance.

Referenced by CHBuilder< E, V >::buildContractionHierarchy(), MSDeterministicHiLevelTrafficLightLogic::decideNextPhase(), MSSwarmTrafficLightLogic::decideNextPhase(), GUIRunThread::deleteSim(), inform(), NLBuilder::init(), GUIRunThread::init(), initOutputOptions(), NBHeightMapper::loadIfSet(), MSSOTLPhaseTrafficLightLogic::MSSOTLPhaseTrafficLightLogic(), MSSOTLPolicyBasedTrafficLightLogic::MSSOTLPolicyBasedTrafficLightLogic(), MSSOTLWaveTrafficLightLogic::MSSOTLWaveTrafficLightLogic(), GUIMessageWindow::registerMsgHandlers(), GUILoadThread::run(), GNELoadThread::run(), GNELoadThread::submitEndAndCleanup(), GUILoadThread::submitEndAndCleanup(), and GUIMessageWindow::unregisterMsgHandlers().

Here is the caller graph for this function:

◆ getWarningInstance()

MsgHandler * MsgHandler::getWarningInstance ( )

static

Returns the instance to add warnings to.

Definition at line 79 of file MsgHandler.cpp.

References MT_WARNING, myFactory, and myWarningInstance.

Referenced by NLHandler::addPhase(), AFRouter< E, N, V >::clone(), AStarRouter< E, V >::clone(), CHRouter< E, V >::clone(), DijkstraRouter< E, V >::clone(), Node2EdgeRouter< E, N, V >::clone(), SystemFrame::close(), ROJTRRouter::compute(), GUIRunThread::deleteSim(), RailwayRouter< E, V >::ensureInternalRouter(), NLBuilder::init(), GUIRunThread::init(), initOutputOptions(), RORoute::isValid(), PCLoaderOSM::loadIfSet(), main(), NBLoadedTLDef::myCompute(), RORouteDef::preComputeCurrentRoute(), GUIMessageWindow::registerMsgHandlers(), RORouteDef::repairCurrentRoute(), GUILoadThread::run(), GNELoadThread::run(), RONet::saveAndRemoveRoutesUntil(), GNELoadThread::submitEndAndCleanup(), GUILoadThread::submitEndAndCleanup(), TraCIServer::TraCIServer(), and GUIMessageWindow::unregisterMsgHandlers().

Here is the caller graph for this function:

◆ inform()

void MsgHandler::inform	(	std::string	msg,
		bool	addType = `true`
	)

virtual

adds a new error to the list

Reimplemented in MsgHandlerSynchronized.

Definition at line 154 of file MsgHandler.cpp.

References build(), getMessageInstance(), inform(), myAmProcessingProcess, myInitialMessages, myRetrievers, and myWasInformed.

Referenced by NLHandler::addPhase(), RORouteHandler::addRide(), RORouteHandler::addStop(), ROVehicle::addStop(), MSSOTLTrafficLightLogic::checkPhases(), clear(), RORouteHandler::closeFlow(), RORouteHandler::closePerson(), RORouteHandler::closePersonFlow(), RORouteHandler::closeRoute(), RORouteHandler::closeRouteDistribution(), RORouteHandler::closeVehicle(), RORouteHandler::closeVehicleTypeDistribution(), AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), ROJTRRouter::compute(), AFCentralizedSPTree< E, N, V >::computeCentralizedSPTree(), ROPerson::computeIntermodal(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), ROVehicle::computeRoute(), MSDeterministicHiLevelTrafficLightLogic::decideNextPhase(), MSSwarmTrafficLightLogic::decideNextPhase(), MapMatcher< E, L, N >::getJunctionTaz(), MapMatcher< E, L, N >::getTaz(), inform(), MsgHandlerSynchronized::inform(), informf(), GUIRunThread::init(), main(), main(), GUIRunThread::makeStep(), MSSOTLPhaseTrafficLightLogic::MSSOTLPhaseTrafficLightLogic(), MSSOTLPolicyBasedTrafficLightLogic::MSSOTLPolicyBasedTrafficLightLogic(), MSSOTLWaveTrafficLightLogic::MSSOTLWaveTrafficLightLogic(), RORouteHandler::openRoute(), RORouteHandler::openRouteDistribution(), RORouteHandler::openVehicleTypeDistribution(), NIXMLConnectionsHandler::parseConnection(), NIXMLConnectionsHandler::parseConnectionDef(), NIXMLConnectionsHandler::parseDeprecatedLaneDefinition(), RORouteHandler::parseEdges(), RORouteHandler::parseFromViaTo(), MapMatcher< E, L, N >::parseGeoEdges(), NIXMLConnectionsHandler::parseLaneBound(), SUMORouteHandler::parseStop(), RORouteDef::preComputeCurrentRoute(), RORouteDef::repairCurrentRoute(), GUILoadThread::run(), MSSOTLTrafficLightLogic::setToATargetPhase(), and TraCIServer::TraCIServer().

◆ informf()

template<typename T , typename... Targs>

void MsgHandler::informf	(	const std::string &	format,
		T	value,
		Targs...	Fargs
	)

inline

adds a new formatted message

Definition at line 122 of file MsgHandler.h.

References aggregationThresholdReached(), StringUtils::format(), and inform().

Referenced by IntermodalRouter< E, L, N, V >::compute(), AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), CHRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), SUMOAbstractRouter< E, V >::computeLooped(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), NIXMLConnectionsHandler::delConnection(), RORoute::isValid(), and NIXMLConnectionsHandler::parseLaneBound().

Here is the caller graph for this function:

◆ initOutputOptions()

void MsgHandler::initOutputOptions ( )

static

init output options

Definition at line 316 of file MsgHandler.cpp.

References addRetriever(), OptionsCont::getBool(), OutputDevice::getDevice(), getErrorInstance(), OptionsCont::getInt(), getMessageInstance(), OptionsCont::getOptions(), OptionsCont::getString(), getWarningInstance(), OptionsCont::isSet(), myInitialMessages, myWriteProcessId, myWriteTimestamps, removeRetriever(), and setAggregationThreshold().

Referenced by NLBuilder::init(), main(), main(), GUILoadThread::run(), and GNELoadThread::run().

Here is the caller graph for this function:

◆ insertLineBreaks()

std::string MsgHandler::insertLineBreaks	(	std::string	msg,
		int	lineWidth
	)

static

reformats a long string to contain newline after a certain line length in px (depending on the current font)

Definition at line 130 of file MsgHandler.cpp.

◆ isRetriever()

bool MsgHandler::isRetriever ( OutputDevice * retriever ) const

Returns whether the given output device retrieves messages from the handler.

Definition at line 254 of file MsgHandler.cpp.

References myRetrievers.

Referenced by addRetriever(), and OutputDevice::closeAll().

Here is the caller graph for this function:

◆ operator<<()

template<class T >

MsgHandler & MsgHandler::operator<< ( const T & t )

inline

Generic output operator.

Returns: The MsgHandler for further processing

Definition at line 162 of file MsgHandler.h.

References myRetrievers.

◆ operator=()

MsgHandler & MsgHandler::operator= ( const MsgHandler & s )

privatedelete

invalid assignment operator

◆ removeRetriever()

void MsgHandler::removeRetriever ( OutputDevice * retriever )

virtual

Removes the retriever from the handler.

Reimplemented in MsgHandlerSynchronized.

Definition at line 245 of file MsgHandler.cpp.

References myRetrievers.

Referenced by GUIRunThread::deleteSim(), initOutputOptions(), MsgHandlerSynchronized::removeRetriever(), removeRetrieverFromAllInstances(), GUILoadThread::run(), GNELoadThread::submitEndAndCleanup(), GUILoadThread::submitEndAndCleanup(), and GUIMessageWindow::unregisterMsgHandlers().

Here is the caller graph for this function:

◆ removeRetrieverFromAllInstances()

void MsgHandler::removeRetrieverFromAllInstances ( OutputDevice * out )

static

ensure that that given output device is no longer used as retriever by any instance

Definition at line 260 of file MsgHandler.cpp.

References myDebugInstance, myErrorInstance, myGLDebugInstance, myMessageInstance, myWarningInstance, and removeRetriever().

Referenced by OutputDevice::close().

Here is the caller graph for this function:

◆ setAggregationThreshold()

void MsgHandler::setAggregationThreshold ( const int thresh )

inlineprotected

Definition at line 211 of file MsgHandler.h.

References myAggregationThreshold.

Referenced by initOutputOptions().

Here is the caller graph for this function:

◆ setFactory()

static void MsgHandler::setFactory ( Factory func )

inlinestatic

Sets the factory function to use for new MsgHandlers.

Definition at line 64 of file MsgHandler.h.

References cleanupOnEnd(), and myFactory.

Referenced by NLBuilder::init(), and main().

Here is the caller graph for this function:

◆ setupI18n()

void MsgHandler::setupI18n ( const std::string & locale = "" )

static

set up gettext stuff

Definition at line 280 of file MsgHandler.cpp.

References myErrorPrefix, myWarningPrefix, TL, UNUSED_PARAMETER, WRITE_WARNING, and WRITE_WARNINGF.

Referenced by OptionsCont::processMetaOptions().

Here is the caller graph for this function:

◆ wasInformed()

bool MsgHandler::wasInformed ( ) const

Returns the information whether any messages were added.

Definition at line 416 of file MsgHandler.cpp.

References myWasInformed.

Referenced by clear(), NIImporter_OpenStreetMap::load(), NBLoadedTLDef::myCompute(), ROLoader::processRoutes(), and XMLSubSys::runParser().

Here is the caller graph for this function:

◆ writeDebugGLMessages()

static bool MsgHandler::writeDebugGLMessages ( )

inlinestatic

check whether to enable/disable gl-debug messages

Definition at line 97 of file MsgHandler.h.

References myWriteDebugGLMessages.

Referenced by SUMORTree::addAdditionalGLObject(), and SUMORTree::removeAdditionalGLObject().

Here is the caller graph for this function:

◆ writeDebugMessages()

static bool MsgHandler::writeDebugMessages ( )

inlinestatic

check whether to enable/disable debug messages

Definition at line 92 of file MsgHandler.h.

References myWriteDebugMessages.

Field Documentation

◆ myAggregationCount

std::map<const std::string, int> MsgHandler::myAggregationCount

private

count for messages of the same type

Definition at line 254 of file MsgHandler.h.

Referenced by aggregationThresholdReached(), and clear().

◆ myAggregationThreshold

int MsgHandler::myAggregationThreshold

private

do not output more messages of the same type if the count exceeds this threshold

Definition at line 251 of file MsgHandler.h.

Referenced by aggregationThresholdReached(), clear(), and setAggregationThreshold().

◆ myAmProcessingProcess

bool MsgHandler::myAmProcessingProcess = false

staticprivate

Information whether a process information is printed to cout.

Definition at line 241 of file MsgHandler.h.

Referenced by beginProcessMsg(), endProcessMsg(), and inform().

◆ myDebugInstance

MsgHandler * MsgHandler::myDebugInstance = nullptr

staticprivate

The instance to handle debug.

Definition at line 226 of file MsgHandler.h.

Referenced by cleanupOnEnd(), getDebugInstance(), and removeRetrieverFromAllInstances().

◆ myErrorInstance

MsgHandler * MsgHandler::myErrorInstance = nullptr

staticprivate

The instance to handle errors.

Definition at line 232 of file MsgHandler.h.

Referenced by cleanupOnEnd(), getErrorInstance(), and removeRetrieverFromAllInstances().

◆ myErrorPrefix

std::string MsgHandler::myErrorPrefix = "Error: "

staticprivate

The possibly translated error prefix (mainly for speedup)

Definition at line 278 of file MsgHandler.h.

Referenced by build(), and setupI18n().

◆ myFactory

MsgHandler::Factory MsgHandler::myFactory = nullptr

staticprivate

The function to call for new MsgHandlers, nullptr means use default constructor.

Definition at line 223 of file MsgHandler.h.

Referenced by getMessageInstance(), getWarningInstance(), and setFactory().

◆ myGLDebugInstance

MsgHandler * MsgHandler::myGLDebugInstance = nullptr

staticprivate

The instance to handle glDebug.

Definition at line 229 of file MsgHandler.h.

Referenced by cleanupOnEnd(), getGLDebugInstance(), and removeRetrieverFromAllInstances().

◆ myInitialMessages

std::vector<std::string> MsgHandler::myInitialMessages

private

storage for initial messages

Definition at line 260 of file MsgHandler.h.

Referenced by clear(), inform(), and initOutputOptions().

◆ myMessageInstance

MsgHandler * MsgHandler::myMessageInstance = nullptr

staticprivate

The instance to handle normal messages.

Definition at line 238 of file MsgHandler.h.

Referenced by cleanupOnEnd(), getMessageInstance(), and removeRetrieverFromAllInstances().

◆ myRetrievers

std::vector<OutputDevice*> MsgHandler::myRetrievers

private

The list of retrievers that shall be informed about new messages or errors.

Definition at line 257 of file MsgHandler.h.

Referenced by addRetriever(), beginProcessMsg(), endProcessMsg(), inform(), isRetriever(), operator<<(), and removeRetriever().

◆ myType

MsgType MsgHandler::myType

private

The type of the instance.

Definition at line 245 of file MsgHandler.h.

Referenced by build().

◆ myWarningInstance

MsgHandler * MsgHandler::myWarningInstance = nullptr

staticprivate

The instance to handle warnings.

Definition at line 235 of file MsgHandler.h.

Referenced by cleanupOnEnd(), getWarningInstance(), and removeRetrieverFromAllInstances().

◆ myWarningPrefix

std::string MsgHandler::myWarningPrefix = "Warning: "

staticprivate

The possibly translated warning prefix (mainly for speedup)

Definition at line 281 of file MsgHandler.h.

Referenced by build(), and setupI18n().

◆ myWasInformed

bool MsgHandler::myWasInformed

private

information whether an output occurred at all

Definition at line 248 of file MsgHandler.h.

Referenced by beginProcessMsg(), clear(), endProcessMsg(), inform(), and wasInformed().

◆ myWriteDebugGLMessages

bool MsgHandler::myWriteDebugGLMessages = false

staticprivate

Flag to enable or disable GL specific debug output.

Definition at line 269 of file MsgHandler.h.

Referenced by enableDebugGLMessages(), and writeDebugGLMessages().

◆ myWriteDebugMessages

bool MsgHandler::myWriteDebugMessages = false

staticprivate

Flag to enable or disable debug output.

This value is used to show more internal information through warning messages about certain operations

Definition at line 266 of file MsgHandler.h.

Referenced by enableDebugMessages(), and writeDebugMessages().

◆ myWriteProcessId

bool MsgHandler::myWriteProcessId = false

staticprivate

Whether to prefix every message with the process id.

Definition at line 275 of file MsgHandler.h.

Referenced by build(), and initOutputOptions().

◆ myWriteTimestamps

bool MsgHandler::myWriteTimestamps = false

staticprivate

Whether to prefix every message with a time stamp.

Definition at line 272 of file MsgHandler.h.

Referenced by build(), and initOutputOptions().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Factory

Member Enumeration Documentation

◆ MsgType

Constructor & Destructor Documentation

◆ MsgHandler() [1/2]

◆ ~MsgHandler()

◆ MsgHandler() [2/2]

Member Function Documentation

◆ addRetriever()

◆ aggregationThresholdReached()

◆ beginProcessMsg()

◆ build()

◆ buildProcessIdPrefix()

◆ buildTimestampPrefix()

◆ cleanupOnEnd()

◆ clear()

◆ enableDebugGLMessages()

◆ enableDebugMessages()

◆ endProcessMsg()

◆ endProcessMsg2()

◆ getDebugInstance()

◆ getErrorInstance()

◆ getGLDebugInstance()

◆ getMessageInstance()

◆ getWarningInstance()

◆ inform()

◆ informf()

◆ initOutputOptions()

◆ insertLineBreaks()

◆ isRetriever()

◆ operator<<()

◆ operator=()

◆ removeRetriever()

◆ removeRetrieverFromAllInstances()

◆ setAggregationThreshold()

◆ setFactory()

◆ setupI18n()

◆ wasInformed()

◆ writeDebugGLMessages()

◆ writeDebugMessages()

Field Documentation

◆ myAggregationCount

◆ myAggregationThreshold

◆ myAmProcessingProcess

◆ myDebugInstance

◆ myErrorInstance

◆ myErrorPrefix

◆ myFactory

◆ myGLDebugInstance

◆ myInitialMessages

◆ myMessageInstance

◆ myRetrievers

◆ myType

◆ myWarningInstance

◆ myWarningPrefix

◆ myWasInformed

◆ myWriteDebugGLMessages

◆ myWriteDebugMessages

◆ myWriteProcessId

◆ myWriteTimestamps