SUMO - Simulation of Urban MObility
MsgHandler Class Reference

#include <MsgHandler.h>

Collaboration diagram for MsgHandler:
Collaboration graph

Public Types

enum  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 ()
 Clears information whether an error occurred previously. More...
 
void endProcessMsg (std::string msg)
 Ends a process information. More...
 
void inform (std::string msg, bool addType=true)
 adds a new error to the list More...
 
bool isRetriever (OutputDevice *retriever) const
 Returns whether the given output device retrieves messages from the handler. More...
 
template<class T >
MsgHandleroperator<< (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 assignLock (AbstractMutex *lock)
 Sets the lock to use The lock will not be deleted. More...
 
static void cleanupOnEnd ()
 Removes pending handler. More...
 
static void enableDebugGLMessages (bool enable)
 enable/disable gl-debug messages More...
 
static void enableDebugMessages (bool enable)
 enable/disable debug messages More...
 
static MsgHandlergetDebugInstance ()
 Returns the instance to add debug to. More...
 
static MsgHandlergetErrorInstance ()
 Returns the instance to add errors to. More...
 
static MsgHandlergetGLDebugInstance ()
 Returns the instance to add GLdebug to. More...
 
static MsgHandlergetMessageInstance ()
 Returns the instance to add normal messages to. More...
 
static MsgHandlergetWarningInstance ()
 Returns the instance to add warnings to. More...
 
static void initOutputOptions ()
 init output options More...
 
static void removeRetrieverFromAllInstances (OutputDevice *out)
 ensure that that given output device is no longer used as retriever by any instance 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

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

Private Types

typedef std::vector< OutputDevice * > RetrieverVector
 Definition of the list of retrievers to inform. More...
 

Private Member Functions

 MsgHandler (MsgType type)
 standard constructor More...
 
 MsgHandler (const MsgHandler &s)=delete
 invalid copy constructor More...
 
MsgHandleroperator= (const MsgHandler &s)=delete
 invalid assignment operator More...
 
 ~MsgHandler ()
 destructor More...
 

Private Attributes

RetrieverVector 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 wehther an error occurred at all More...
 

Static Private Attributes

static bool myAmProcessingProcess = false
 Information whether a process information is printed to cout. More...
 
static MsgHandlermyDebugInstance = nullptr
 The instance to handle debug. More...
 
static MsgHandlermyErrorInstance = nullptr
 The instance to handle errors. More...
 
static MsgHandlermyGLDebugInstance = nullptr
 The instance to handle glDebug. More...
 
static AbstractMutexmyLock = nullptr
 The lock if any has to be used. The lock will not be deleted. More...
 
static MsgHandlermyMessageInstance = nullptr
 The instance to handle normal messages. More...
 
static MsgHandlermyWarningInstance = nullptr
 The instance to handle warnings. More...
 
static bool myWriteDebugGLMessages
 
static bool myWriteDebugMessages
 Flag to enable or disable debug GL Functions. More...
 

Detailed Description

MsgHandler

Definition at line 46 of file MsgHandler.h.

Member Typedef Documentation

◆ RetrieverVector

typedef std::vector<OutputDevice*> MsgHandler::RetrieverVector
private

Definition of the list of retrievers to inform.

Definition at line 214 of file MsgHandler.h.

Member Enumeration Documentation

◆ MsgType

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 an debug.

MT_GLDEBUG 

The message is an debug.

Definition at line 53 of file MsgHandler.h.

Constructor & Destructor Documentation

◆ MsgHandler() [1/2]

MsgHandler::MsgHandler ( MsgType  type)
private

◆ ~MsgHandler()

MsgHandler::~MsgHandler ( )
private

destructor

Definition at line 302 of file MsgHandler.cpp.

Referenced by build().

◆ MsgHandler() [2/2]

MsgHandler::MsgHandler ( const MsgHandler s)
privatedelete

invalid copy constructor

Member Function Documentation

◆ addRetriever()

void MsgHandler::addRetriever ( OutputDevice retriever)

◆ assignLock()

void MsgHandler::assignLock ( AbstractMutex lock)
static

Sets the lock to use The lock will not be deleted.

Definition at line 313 of file MsgHandler.cpp.

References myLock.

Referenced by main(), and writeDebugGLMessages().

◆ beginProcessMsg()

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

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.

Definition at line 136 of file MsgHandler.cpp.

References build(), AbstractMutex::lock(), myAmProcessingProcess, myLock, myRetrievers, myWasInformed, and AbstractMutex::unlock().

Referenced by writeDebugGLMessages().

◆ build()

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

Builds the string which includes the mml-message type.

Definition at line 153 of file MsgHandler.h.

References MsgHandler(), MT_DEBUG, MT_ERROR, MT_GLDEBUG, MT_MESSAGE, MT_WARNING, myType, and ~MsgHandler().

Referenced by beginProcessMsg(), and inform().

◆ cleanupOnEnd()

void MsgHandler::cleanupOnEnd ( )
static

◆ clear()

void MsgHandler::clear ( )

Clears information whether an error occurred previously.

Definition at line 173 of file MsgHandler.cpp.

References AbstractMutex::lock(), myLock, myWasInformed, and AbstractMutex::unlock().

Referenced by NLBuilder::init(), loadJTRDefinitions(), main(), NBLoadedTLDef::myCompute(), GNELoadThread::run(), GUILoadThread::run(), and writeDebugGLMessages().

◆ enableDebugGLMessages()

void MsgHandler::enableDebugGLMessages ( bool  enable)
static

enable/disable gl-debug messages

Definition at line 108 of file MsgHandler.cpp.

References myWriteDebugGLMessages.

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

◆ enableDebugMessages()

void MsgHandler::enableDebugMessages ( bool  enable)
static

enable/disable debug messages

Definition at line 103 of file MsgHandler.cpp.

References myWriteDebugMessages.

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

◆ endProcessMsg()

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

◆ getDebugInstance()

MsgHandler * MsgHandler::getDebugInstance ( )
static

◆ getErrorInstance()

◆ getGLDebugInstance()

MsgHandler * MsgHandler::getGLDebugInstance ( )
static

◆ getMessageInstance()

◆ getWarningInstance()

◆ inform()

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

adds a new error to the list

Definition at line 113 of file MsgHandler.cpp.

References build(), getMessageInstance(), inform(), AbstractMutex::lock(), myAmProcessingProcess, myLock, myRetrievers, myWasInformed, and AbstractMutex::unlock().

Referenced by RORouteHandler::addPersonTrip(), NLHandler::addPhase(), ROVehicle::addStop(), RORouteHandler::addStop(), MSSOTLTrafficLightLogic::checkPhases(), RORouteHandler::closeFlow(), RORouteHandler::closeRoute(), RORouteHandler::closeRouteDistribution(), RORouteHandler::closeVehicle(), RORouteHandler::closeVehicleTypeDistribution(), ROJTRRouter::compute(), DijkstraRouter< E, V, BASE >::compute(), AStarRouter< MSEdge, SUMOVehicle, SUMOAbstractRouterPermissions< MSEdge, SUMOVehicle > >::compute(), CHRouter< E, V, BASE >::compute(), ROPerson::computeIntermodal(), ROVehicle::computeRoute(), MSDeterministicHiLevelTrafficLightLogic::decideNextPhase(), MSSwarmTrafficLightLogic::decideNextPhase(), inform(), GUIRunThread::init(), main(), GUIRunThread::makeStep(), MSPhaseDefinition::MSPhaseDefinition(), MSSOTLPhaseTrafficLightLogic::MSSOTLPhaseTrafficLightLogic(), MSSOTLPolicyBasedTrafficLightLogic::MSSOTLPolicyBasedTrafficLightLogic(), MSSOTLWaveTrafficLightLogic::MSSOTLWaveTrafficLightLogic(), NIXMLConnectionsHandler::myStartElement(), RORouteHandler::myStartElement(), PCLoaderOSM::NodesHandler::myStartElement(), PCLoaderOSM::RelationsHandler::myStartElement(), PCLoaderOSM::EdgesHandler::myStartElement(), RORouteHandler::openRoute(), RORouteHandler::openRouteDistribution(), RORouteHandler::openVehicleTypeDistribution(), NIXMLConnectionsHandler::parseConnection(), NIXMLConnectionsHandler::parseDeprecatedLaneDefinition(), RORouteHandler::parseEdges(), RORouteHandler::parseFromViaTo(), NIXMLConnectionsHandler::parseLaneBound(), SUMORouteHandler::parseStop(), RORouteDef::preComputeCurrentRoute(), RORouteDef::repairCurrentRoute(), GUILoadThread::run(), MSSOTLTrafficLightLogic::setToATargetPhase(), TraCIServer::TraCIServer(), and writeDebugGLMessages().

◆ initOutputOptions()

◆ isRetriever()

bool MsgHandler::isRetriever ( OutputDevice retriever) const

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

Definition at line 214 of file MsgHandler.cpp.

References myRetrievers.

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

◆ operator<<()

template<class T >
MsgHandler& MsgHandler::operator<< ( const T &  t)
inline

Generic output operator.

Returns
The MsgHandler for further processing

Definition at line 143 of file MsgHandler.h.

References myRetrievers.

◆ operator=()

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

invalid assignment operator

◆ removeRetriever()

◆ 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 220 of file MsgHandler.cpp.

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

Referenced by OutputDevice::close(), and writeDebugGLMessages().

◆ wasInformed()

bool MsgHandler::wasInformed ( ) const

Returns the information whether any messages were added.

Definition at line 307 of file MsgHandler.cpp.

References myWasInformed.

Referenced by NLBuilder::build(), ROLoader::openRoutes(), ROLoader::processRoutes(), XMLSubSys::runParser(), and writeDebugGLMessages().

◆ writeDebugGLMessages()

static bool MsgHandler::writeDebugGLMessages ( )
inlinestatic

◆ writeDebugMessages()

static bool MsgHandler::writeDebugMessages ( )
inlinestatic

check whether to enable/disable debug messages

Definition at line 88 of file MsgHandler.h.

References myWriteDebugMessages.

Field Documentation

◆ myAmProcessingProcess

bool MsgHandler::myAmProcessingProcess = false
staticprivate

Information whether a process information is printed to cout.

Definition at line 201 of file MsgHandler.h.

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

◆ myDebugInstance

MsgHandler * MsgHandler::myDebugInstance = nullptr
staticprivate

The instance to handle debug.

Definition at line 186 of file MsgHandler.h.

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

◆ myErrorInstance

MsgHandler * MsgHandler::myErrorInstance = nullptr
staticprivate

The instance to handle errors.

Definition at line 192 of file MsgHandler.h.

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

◆ myGLDebugInstance

MsgHandler * MsgHandler::myGLDebugInstance = nullptr
staticprivate

The instance to handle glDebug.

Definition at line 189 of file MsgHandler.h.

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

◆ myLock

AbstractMutex * MsgHandler::myLock = nullptr
staticprivate

The lock if any has to be used. The lock will not be deleted.

Definition at line 204 of file MsgHandler.h.

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

◆ myMessageInstance

MsgHandler * MsgHandler::myMessageInstance = nullptr
staticprivate

The instance to handle normal messages.

Definition at line 198 of file MsgHandler.h.

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

◆ myRetrievers

RetrieverVector MsgHandler::myRetrievers
private

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

Definition at line 217 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 208 of file MsgHandler.h.

Referenced by build().

◆ myWarningInstance

MsgHandler * MsgHandler::myWarningInstance = nullptr
staticprivate

The instance to handle warnings.

Definition at line 195 of file MsgHandler.h.

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

◆ myWasInformed

bool MsgHandler::myWasInformed
private

information wehther an error occurred at all

Definition at line 211 of file MsgHandler.h.

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

◆ myWriteDebugGLMessages

bool MsgHandler::myWriteDebugGLMessages
staticprivate

Definition at line 231 of file MsgHandler.h.

Referenced by enableDebugGLMessages(), and writeDebugGLMessages().

◆ myWriteDebugMessages

bool MsgHandler::myWriteDebugMessages
staticprivate

Flag to enable or disable debug GL Functions.

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

Definition at line 230 of file MsgHandler.h.

Referenced by enableDebugMessages(), and writeDebugMessages().


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