#include <MsgHandlerSynchronized.h>

Inheritance diagram for MsgHandlerSynchronized:

Collaboration diagram for MsgHandlerSynchronized:

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

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

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

void	clear (bool resetInformed=true)
	Clears information whether an error occurred previously. More...

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

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

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

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

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

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

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

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

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

static MsgHandler *	create (MsgType type)

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

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

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

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

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

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

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

static void	initOutputOptions ()
	init output options More...

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) More...

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

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

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

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

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

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

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

std::string	buildProcessIdPrefix (void) const

std::string	buildTimestampPrefix (void) const

void	setAggregationThreshold (const int thresh)

Private Types
typedef MsgHandler (	Factory) (MsgType)

Private Member Functions
	MsgHandlerSynchronized (const MsgHandlerSynchronized &s)=delete
	invalid copy constructor More...

	MsgHandlerSynchronized (MsgType type)
	standard constructor More...

MsgHandlerSynchronized &	operator= (const MsgHandlerSynchronized &s)=delete
	invalid assignment operator More...

	~MsgHandlerSynchronized ()
	destructor More...

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

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

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

FXMutex	myLock
	The lock for synchronizing all outputs using handlers of this class. More...

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

MsgType	myType
	The type of the instance. More...

bool	myWasInformed
	information whether an output occurred at all More...

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

MsgHandlerSynchronized

Definition at line 46 of file MsgHandlerSynchronized.h.

Member Typedef Documentation

◆ Factory

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

privateinherited

Definition at line 60 of file MsgHandler.h.

Member Enumeration Documentation

◆ MsgType

enum MsgHandler::MsgType

stronginherited

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

◆ MsgHandlerSynchronized() [1/2]

MsgHandlerSynchronized::MsgHandlerSynchronized ( MsgType type )

inlineprivate

standard constructor

Definition at line 102 of file MsgHandlerSynchronized.h.

Referenced by create().

Here is the caller graph for this function:

◆ ~MsgHandlerSynchronized()

MsgHandlerSynchronized::~MsgHandlerSynchronized ( )

inlineprivate

destructor

Definition at line 107 of file MsgHandlerSynchronized.h.

◆ MsgHandlerSynchronized() [2/2]

MsgHandlerSynchronized::MsgHandlerSynchronized ( const MsgHandlerSynchronized & s )

privatedelete

invalid copy constructor

Member Function Documentation

◆ addRetriever()

void MsgHandlerSynchronized::addRetriever ( OutputDevice * retriever )

inlinevirtual

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

Reimplemented from MsgHandler.

Definition at line 83 of file MsgHandlerSynchronized.h.

References MsgHandler::addRetriever(), and myLock.

◆ aggregationThresholdReached()

bool MsgHandlerSynchronized::aggregationThresholdReached ( const std::string & format )

inlineprotectedvirtual

Reimplemented from MsgHandler.

Definition at line 95 of file MsgHandlerSynchronized.h.

References MsgHandler::aggregationThresholdReached(), and myLock.

◆ beginProcessMsg()

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

inlinevirtual

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 from MsgHandler.

Definition at line 65 of file MsgHandlerSynchronized.h.

References MsgHandler::beginProcessMsg(), and myLock.

◆ build()

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

inlineprotectedinherited

Builds the string which includes the mml-message type.

Definition at line 176 of file MsgHandler.h.

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

Referenced by MsgHandler::beginProcessMsg(), and MsgHandler::inform().

Here is the caller graph for this function:

◆ buildProcessIdPrefix()

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

protectedinherited

Definition at line 388 of file MsgHandler.cpp.

Referenced by MsgHandler::build().

Here is the caller graph for this function:

◆ buildTimestampPrefix()

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

protectedinherited

Definition at line 374 of file MsgHandler.cpp.

Referenced by MsgHandler::build().

Here is the caller graph for this function:

◆ cleanupOnEnd()

void MsgHandler::cleanupOnEnd ( )

staticinherited

Removes pending handler.

Definition at line 359 of file MsgHandler.cpp.

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

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

Here is the caller graph for this function:

◆ clear()

void MsgHandlerSynchronized::clear ( bool resetInformed = true )

inlinevirtual

Clears information whether an error occurred previously.

Reimplemented from MsgHandler.

Definition at line 77 of file MsgHandlerSynchronized.h.

References MsgHandler::clear(), and myLock.

◆ create()

static MsgHandler* MsgHandlerSynchronized::create ( MsgType type )

inlinestatic

Definition at line 48 of file MsgHandlerSynchronized.h.

References MsgHandlerSynchronized().

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

Here is the caller graph for this function:

◆ enableDebugGLMessages()

void MsgHandler::enableDebugGLMessages ( bool enable )

staticinherited

enable/disable gl-debug messages

Definition at line 124 of file MsgHandler.cpp.

References MsgHandler::myWriteDebugGLMessages.

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

Here is the caller graph for this function:

◆ enableDebugMessages()

void MsgHandler::enableDebugMessages ( bool enable )

staticinherited

enable/disable debug messages

Definition at line 119 of file MsgHandler.cpp.

References MsgHandler::myWriteDebugMessages.

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

Here is the caller graph for this function:

◆ endProcessMsg()

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

inlinevirtual

Ends a process information.

Reimplemented from MsgHandler.

Definition at line 71 of file MsgHandlerSynchronized.h.

References MsgHandler::endProcessMsg(), and myLock.

◆ endProcessMsg2()

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

virtualinherited

Ends a process information with predefined messages.

Definition at line 187 of file MsgHandler.cpp.

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

◆ getDebugInstance()

MsgHandler * MsgHandler::getDebugInstance ( )

staticinherited

Returns the instance to add debug to.

Definition at line 101 of file MsgHandler.cpp.

References MsgHandler::MsgHandler(), MsgHandler::MT_DEBUG, and MsgHandler::myDebugInstance.

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

Here is the caller graph for this function:

◆ getErrorInstance()

MsgHandler * MsgHandler::getErrorInstance ( )

staticinherited

Returns the instance to add errors to.

Definition at line 92 of file MsgHandler.cpp.

References MsgHandler::MsgHandler(), MsgHandler::MT_ERROR, and MsgHandler::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(), MsgHandler::initOutputOptions(), RORoute::isValid(), NIImporter_OpenStreetMap::load(), PCLoaderOSM::loadIfSet(), loadJTRDefinitions(), NIImporter_ArcView::loadNetwork(), MSNet::loadState(), 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 ( )

staticinherited

Returns the instance to add GLdebug to.

Definition at line 110 of file MsgHandler.cpp.

References MsgHandler::MsgHandler(), MsgHandler::MT_GLDEBUG, and MsgHandler::myGLDebugInstance.

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

Here is the caller graph for this function:

◆ getMessageInstance()

MsgHandler * MsgHandler::getMessageInstance ( )

staticinherited

Returns the instance to add normal messages to.

Definition at line 66 of file MsgHandler.cpp.

References MsgHandler::MsgHandler(), MsgHandler::MT_MESSAGE, MsgHandler::myFactory, and MsgHandler::myMessageInstance.

Referenced by CHBuilder< E, V >::buildContractionHierarchy(), MSDeterministicHiLevelTrafficLightLogic::decideNextPhase(), MSSwarmTrafficLightLogic::decideNextPhase(), GUIRunThread::deleteSim(), MsgHandler::inform(), NLBuilder::init(), GUIRunThread::init(), MsgHandler::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 ( )

staticinherited

Returns the instance to add warnings to.

Definition at line 79 of file MsgHandler.cpp.

References MsgHandler::MsgHandler(), MsgHandler::MT_WARNING, MsgHandler::myFactory, and MsgHandler::myWarningInstance.

Referenced by NLHandler::addPhase(), AStarRouter< E, V >::clone(), CHRouter< E, V >::clone(), DijkstraRouter< E, V >::clone(), SystemFrame::close(), ROJTRRouter::compute(), GUIRunThread::deleteSim(), RailwayRouter< E, V >::ensureInternalRouter(), NLBuilder::init(), GUIRunThread::init(), MsgHandler::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 MsgHandlerSynchronized::inform	(	std::string	msg,
		bool	addType = `true`
	)

inlinevirtual

adds a new error to the list

Reimplemented from MsgHandler.

Definition at line 53 of file MsgHandlerSynchronized.h.

References MsgHandler::inform(), and myLock.

◆ informf()

template<typename T , typename... Targs>

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

inlineinherited

adds a new formatted message

Definition at line 122 of file MsgHandler.h.

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

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

Here is the caller graph for this function:

◆ initOutputOptions()

void MsgHandler::initOutputOptions ( )

staticinherited

init output options

Definition at line 316 of file MsgHandler.cpp.

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

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

Here is the caller graph for this function:

◆ insertLineBreaks()

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

staticinherited

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

inherited

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

Definition at line 254 of file MsgHandler.cpp.

References MsgHandler::myRetrievers.

Referenced by MsgHandler::addRetriever().

Here is the caller graph for this function:

◆ operator<<()

template<class T >

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

inlineinherited

Generic output operator.

Returns: The MsgHandler for further processing

Definition at line 162 of file MsgHandler.h.

References MsgHandler::myRetrievers.

◆ operator=()

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

privatedelete

invalid assignment operator

◆ removeRetriever()

void MsgHandlerSynchronized::removeRetriever ( OutputDevice * retriever )

inlinevirtual

Removes the retriever from the handler.

Reimplemented from MsgHandler.

Definition at line 89 of file MsgHandlerSynchronized.h.

References myLock, and MsgHandler::removeRetriever().

◆ removeRetrieverFromAllInstances()

void MsgHandler::removeRetrieverFromAllInstances ( OutputDevice * out )

staticinherited

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

Definition at line 260 of file MsgHandler.cpp.

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

Referenced by OutputDevice::close().

Here is the caller graph for this function:

◆ setAggregationThreshold()

void MsgHandler::setAggregationThreshold ( const int thresh )

inlineprotectedinherited

Definition at line 211 of file MsgHandler.h.

References MsgHandler::myAggregationThreshold.

Referenced by MsgHandler::initOutputOptions().

Here is the caller graph for this function:

◆ setFactory()

static void MsgHandler::setFactory ( Factory func )

inlinestaticinherited

Sets the factory function to use for new MsgHandlers.

Definition at line 64 of file MsgHandler.h.

References MsgHandler::cleanupOnEnd(), and MsgHandler::myFactory.

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

Here is the caller graph for this function:

◆ setupI18n()

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

staticinherited

set up gettext stuff

Definition at line 280 of file MsgHandler.cpp.

References MsgHandler::myErrorPrefix, MsgHandler::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

inherited

Returns the information whether any messages were added.

Definition at line 416 of file MsgHandler.cpp.

References MsgHandler::myWasInformed.

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

Here is the caller graph for this function:

◆ writeDebugGLMessages()

static bool MsgHandler::writeDebugGLMessages ( )

inlinestaticinherited

check whether to enable/disable gl-debug messages

Definition at line 97 of file MsgHandler.h.

References MsgHandler::myWriteDebugGLMessages.

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

Here is the caller graph for this function:

◆ writeDebugMessages()

static bool MsgHandler::writeDebugMessages ( )

inlinestaticinherited

check whether to enable/disable debug messages

Definition at line 92 of file MsgHandler.h.

References MsgHandler::myWriteDebugMessages.

Field Documentation

◆ myAggregationCount

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

privateinherited

count for messages of the same type

Definition at line 254 of file MsgHandler.h.

Referenced by MsgHandler::aggregationThresholdReached(), and MsgHandler::clear().

◆ myAggregationThreshold

int MsgHandler::myAggregationThreshold

privateinherited

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 MsgHandler::aggregationThresholdReached(), MsgHandler::clear(), and MsgHandler::setAggregationThreshold().

◆ myAmProcessingProcess

bool MsgHandler::myAmProcessingProcess = false

staticprivateinherited

Information whether a process information is printed to cout.

Definition at line 241 of file MsgHandler.h.

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

◆ myDebugInstance

MsgHandler * MsgHandler::myDebugInstance = nullptr

staticprivateinherited

The instance to handle debug.

Definition at line 226 of file MsgHandler.h.

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

◆ myErrorInstance

MsgHandler * MsgHandler::myErrorInstance = nullptr

staticprivateinherited

The instance to handle errors.

Definition at line 232 of file MsgHandler.h.

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

◆ myErrorPrefix

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

staticprivateinherited

The possibly translated error prefix (mainly for speedup)

Definition at line 278 of file MsgHandler.h.

Referenced by MsgHandler::build(), and MsgHandler::setupI18n().

◆ myFactory

MsgHandler::Factory MsgHandler::myFactory = nullptr

staticprivateinherited

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

Definition at line 223 of file MsgHandler.h.

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

◆ myGLDebugInstance

MsgHandler * MsgHandler::myGLDebugInstance = nullptr

staticprivateinherited

The instance to handle glDebug.

Definition at line 229 of file MsgHandler.h.

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

◆ myInitialMessages

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

privateinherited

storage for initial messages

Definition at line 260 of file MsgHandler.h.

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

◆ myLock

FXMutex MsgHandlerSynchronized::myLock

private

The lock for synchronizing all outputs using handlers of this class.

Definition at line 111 of file MsgHandlerSynchronized.h.

Referenced by addRetriever(), aggregationThresholdReached(), beginProcessMsg(), clear(), endProcessMsg(), inform(), and removeRetriever().

◆ myMessageInstance

MsgHandler * MsgHandler::myMessageInstance = nullptr

staticprivateinherited

The instance to handle normal messages.

Definition at line 238 of file MsgHandler.h.

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

◆ myRetrievers

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

privateinherited

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

Definition at line 257 of file MsgHandler.h.

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

◆ myType

MsgType MsgHandler::myType

privateinherited

The type of the instance.

Definition at line 245 of file MsgHandler.h.

Referenced by MsgHandler::build().

◆ myWarningInstance

MsgHandler * MsgHandler::myWarningInstance = nullptr

staticprivateinherited

The instance to handle warnings.

Definition at line 235 of file MsgHandler.h.

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

◆ myWarningPrefix

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

staticprivateinherited

The possibly translated warning prefix (mainly for speedup)

Definition at line 281 of file MsgHandler.h.

Referenced by MsgHandler::build(), and MsgHandler::setupI18n().

◆ myWasInformed

bool MsgHandler::myWasInformed

privateinherited

information whether an output occurred at all

Definition at line 248 of file MsgHandler.h.

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

◆ myWriteDebugGLMessages

bool MsgHandler::myWriteDebugGLMessages = false

staticprivateinherited

Flag to enable or disable GL specific debug output.

Definition at line 269 of file MsgHandler.h.

Referenced by MsgHandler::enableDebugGLMessages(), and MsgHandler::writeDebugGLMessages().

◆ myWriteDebugMessages

bool MsgHandler::myWriteDebugMessages = false

staticprivateinherited

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 MsgHandler::enableDebugMessages(), and MsgHandler::writeDebugMessages().

◆ myWriteProcessId

bool MsgHandler::myWriteProcessId = false

staticprivateinherited

Whether to prefix every message with the process id.

Definition at line 275 of file MsgHandler.h.

Referenced by MsgHandler::build(), and MsgHandler::initOutputOptions().

◆ myWriteTimestamps

bool MsgHandler::myWriteTimestamps = false

staticprivateinherited

Whether to prefix every message with a time stamp.

Definition at line 272 of file MsgHandler.h.

Referenced by MsgHandler::build(), and MsgHandler::initOutputOptions().

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

MsgHandlerSynchronized.h

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

◆ MsgHandlerSynchronized() [1/2]

◆ ~MsgHandlerSynchronized()

◆ MsgHandlerSynchronized() [2/2]

Member Function Documentation

◆ addRetriever()

◆ aggregationThresholdReached()

◆ beginProcessMsg()

◆ build()

◆ buildProcessIdPrefix()

◆ buildTimestampPrefix()

◆ cleanupOnEnd()

◆ clear()

◆ create()

◆ 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

◆ myLock

◆ myMessageInstance

◆ myRetrievers

◆ myType

◆ myWarningInstance

◆ myWarningPrefix

◆ myWasInformed

◆ myWriteDebugGLMessages

◆ myWriteDebugMessages

◆ myWriteProcessId

◆ myWriteTimestamps