#include <GUIRunThread.h>

Inheritance diagram for GUIRunThread:

Collaboration diagram for GUIRunThread:

Public Types
enum	{ ID_THREAD_EVENT }
	FOX declaration. More...

Public Member Functions
virtual void	begin ()
	starts the simulation (execution of one step after another)

virtual void	deleteSim ()
	deletes the existing simulation

void	enableLibsumo ()
	enable lib SUMO

FXMutex &	getBreakpointLock ()
	get breakpoint lock

std::vector< SUMOTime > &	getBreakpoints ()
	get list of breakpoints

GUINet &	getNet () const
	returns the loaded network

SUMOTime	getSimBegin ()
	get simulation begin time

SUMOTime	getSimEndTime () const
	get simulation end time

	GUIRunThread (FXApp app, MFXInterThreadEventClient mw, double &simDelay, MFXSynchQue< GUIEvent * > &eq, FXEX::MFXThreadEvent &ev)
	constructor

virtual bool	init (GUINet *net, SUMOTime start, SUMOTime end)
	initialises the thread with the new simulation

bool	networkAvailable () const
	returns the information whether a network has been loaded

long	onThreadEvent (FXObject , FXSelector, void )

long	onThreadSignal (FXObject , FXSelector, void )

void	prepareDestruction ()
	halts the thread before it shall be deleted

void	resume ()
	called when the user presses the "resume"-button

void	retrieveMessage (const MsgHandler::MsgType type, const std::string &msg)
	Retrieves messages from the loading module.

virtual FXint	run ()
	starts the execution

void	signal ()

void	signal (FXuint seltype)

virtual bool	simulationIsStartable () const
	check if simulation is startable

virtual bool	simulationIsStepable () const
	check if simulation is stepable

virtual bool	simulationIsStopable () const
	check if simulation is stopableo

void	singleStep ()
	called when the user presses the "single step"-button

void	stop ()
	halts the simulation execution

void	tryStep ()
	try simulation step

virtual	~GUIRunThread ()
	destructor

Static Public Member Functions
static void	sleep (long ms)

Protected Member Functions
void	makeStep ()
	make simulation step

void	waitForSnapshots (const SUMOTime snapshotTime)
	wait for snapshots

Protected Attributes
bool	myAmLibsumo
	whether we are running in libsumo

FXApp *	myApp = nullptr
	pointer to APP

FXMutex	myBreakpointLock
	Lock for modifying the list of breakpoints.

std::vector< SUMOTime >	myBreakpoints
	List of breakpoints.

MFXInterThreadEventClient *	myClient = nullptr
	thread client

OutputDevice *	myErrorRetriever
	The instances of message retriever encapsulations.

MFXSynchQue< GUIEvent * > &	myEventQue
	event queue

FXEX::MFXThreadEvent &	myEventThrow
	thrower events

bool	myHalting
	information whether the simulation is halting (is not being executed)

bool	myHaveSignaledEnd
	whether the simulation already ended

long	myLastBreakMillis
	last time the simulation took a microsecond break for the fox event loop to catch up (#9028)

long	myLastEndMillis
	end of the last simulation step

OutputDevice *	myMessageRetriever

GUINet *	myNet
	the loaded simulation network

bool	myOk
	flag to check if all is ok

bool	myQuit
	information whether the thread shall be stopped

double &	mySimDelay
	simulation delay

SUMOTime	mySimEndTime

SUMOTime	mySimStartTime
	the times the simulation starts and ends with

bool	mySimulationInProgress
	information whether a simulation step is being performed

FXMutex	mySimulationLock
	mutex for lock simulation

bool	mySingle
	information whether the thread is running in single step mode

OutputDevice *	myWarningRetriever

Private Attributes
FXEX::MFXThreadEventHandle	event
	event

Detailed Description

This thread executes the given simulation stepwise to allow parallel visualisation. The avoidance of collisions between the simulation execution and its visualisation is done individually for every lane using mutexes

Definition at line 53 of file GUIRunThread.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

FOX declaration.

Enumerator
ID_THREAD_EVENT

Definition at line 37 of file MFXSingleEventThread.h.

Constructor & Destructor Documentation

◆ GUIRunThread()

GUIRunThread::GUIRunThread	(	FXApp *	app,
		MFXInterThreadEventClient *	mw,
		double &	simDelay,
		MFXSynchQue< GUIEvent * > &	eq,
		FXEX::MFXThreadEvent &	ev
	)

constructor

Definition at line 51 of file GUIRunThread.cpp.

References MsgHandler::MT_ERROR, MsgHandler::MT_MESSAGE, MsgHandler::MT_WARNING, myErrorRetriever, myMessageRetriever, myWarningRetriever, and retrieveMessage().

◆ ~GUIRunThread()

GUIRunThread::~GUIRunThread ( )

virtual

destructor

Definition at line 72 of file GUIRunThread.cpp.

References deleteSim(), myErrorRetriever, myMessageRetriever, myNet, myQuit, mySimulationInProgress, and myWarningRetriever.

Member Function Documentation

◆ begin()

void GUIRunThread::begin ( )

virtual

starts the simulation (execution of one step after another)

Definition at line 271 of file GUIRunThread.cpp.

References myOk, mySimStartTime, time2string(), TL, and WRITE_MESSAGEF.

Referenced by GUIApplicationWindow::onCmdStart(), and GUIApplicationWindow::onCmdStep().

Here is the caller graph for this function:

◆ deleteSim()

void GUIRunThread::deleteSim ( )

virtual

deletes the existing simulation

Definition at line 292 of file GUIRunThread.cpp.

References MsgHandler::cleanupOnEnd(), GUIGlObjectStorage::clear(), MsgHandler::clear(), OutputDevice::closeAll(), MSNet::closeSimulation(), MsgHandler::getErrorInstance(), MsgHandler::getMessageInstance(), MSNet::getStateMessage(), MsgHandler::getWarningInstance(), GUIGlObjectStorage::gIDStorage, myErrorRetriever, myHalting, myMessageRetriever, myNet, mySimEndTime, mySimStartTime, mySimulationInProgress, mySimulationLock, myWarningRetriever, MsgHandler::removeRetriever(), MSNet::simulationState(), and MFXSingleEventThread::sleep().

Referenced by GUIApplicationWindow::closeAllWindows(), run(), and ~GUIRunThread().

Here is the caller graph for this function:

◆ enableLibsumo()

void GUIRunThread::enableLibsumo ( )

inline

enable lib SUMO

Definition at line 129 of file GUIRunThread.h.

References myAmLibsumo.

◆ getBreakpointLock()

FXMutex & GUIRunThread::getBreakpointLock ( )

inline

get breakpoint lock

Definition at line 124 of file GUIRunThread.h.

References myBreakpointLock.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded(), GUIApplicationWindow::onCmdEditBreakpoints(), GUIApplicationWindow::retrieveBreakpoints(), and GUIApplicationWindow::setBreakpoints().

Here is the caller graph for this function:

◆ getBreakpoints()

std::vector< SUMOTime > & GUIRunThread::getBreakpoints ( )

inline

get list of breakpoints

Definition at line 119 of file GUIRunThread.h.

References myBreakpoints.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded(), GUIApplicationWindow::onCmdEditBreakpoints(), GUIApplicationWindow::retrieveBreakpoints(), and GUIApplicationWindow::setBreakpoints().

Here is the caller graph for this function:

◆ getNet()

GUINet & GUIRunThread::getNet ( ) const

returns the loaded network

Definition at line 318 of file GUIRunThread.cpp.

References myNet.

Referenced by GUIApplicationWindow::checkGamingEventsDRT(), GUIApplicationWindow::getCurrentSimTime(), GUIApplicationWindow::handleEvent_SimulationLoaded(), GUIApplicationWindow::handleEvent_SimulationStep(), GUIApplicationWindow::onCmdDemandScale(), GUIApplicationWindow::onCmdOpenShapes(), GUIApplicationWindow::onCmdTimeToggle(), GUIApplicationWindow::openNewView(), and tryStep().

Here is the caller graph for this function:

◆ getSimBegin()

SUMOTime GUIRunThread::getSimBegin ( )

inline

get simulation begin time

Definition at line 109 of file GUIRunThread.h.

References mySimStartTime.

Referenced by GUIApplicationWindow::onCmdEditBreakpoints().

Here is the caller graph for this function:

◆ getSimEndTime()

SUMOTime GUIRunThread::getSimEndTime ( ) const

inline

get simulation end time

Definition at line 114 of file GUIRunThread.h.

References mySimEndTime.

Referenced by GUIApplicationWindow::updateTimeLCD().

Here is the caller graph for this function:

◆ init()

bool GUIRunThread::init	(	GUINet *	net,
		SUMOTime	start,
		SUMOTime	end
	)

virtual

initialises the thread with the new simulation

Definition at line 85 of file GUIRunThread.cpp.

References MsgHandler::addRetriever(), MsgHandler::getErrorInstance(), MsgHandler::getMessageInstance(), OptionsCont::getOptions(), MsgHandler::getWarningInstance(), MsgHandler::inform(), MSNet::loadRoutes(), myErrorRetriever, myHalting, myHaveSignaledEnd, myMessageRetriever, myNet, myOk, mySimEndTime, mySimStartTime, mySimulationInProgress, mySimulationLock, myWarningRetriever, MSNet::setCurrentTimeStep(), TL, and WRITE_ERROR.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded().

Here is the caller graph for this function:

◆ makeStep()

void GUIRunThread::makeStep ( )

protected

make simulation step

Definition at line 187 of file GUIRunThread.cpp.

References MSNet::adaptToState(), DELTA_T, MSNet::getCurrentTimeStep(), MsgHandler::getErrorInstance(), GUINet::guiSimulationStep(), MsgHandler::inform(), myAmLibsumo, myEventQue, myEventThrow, myHalting, myHaveSignaledEnd, myNet, myOk, mySimEndTime, mySimulationInProgress, mySimulationLock, MFXSynchQue< T, Container >::push_back(), FXEX::MFXThreadEvent::signal(), MSNet::SIMSTATE_CONNECTION_CLOSED, MSNet::SIMSTATE_END_STEP_REACHED, MSNet::SIMSTATE_ERROR_IN_SIM, MSNet::SIMSTATE_LOADING, MSNet::SIMSTATE_NO_FURTHER_VEHICLES, MSNet::SIMSTATE_TOO_MANY_TELEPORTS, MSNet::simulationState(), GUINet::simulationStep(), and WRITE_ERROR.

Referenced by tryStep().

Here is the caller graph for this function:

◆ networkAvailable()

bool GUIRunThread::networkAvailable ( ) const

returns the information whether a network has been loaded

Definition at line 286 of file GUIRunThread.cpp.

References myNet.

Here is the caller graph for this function:

◆ onThreadEvent()

long MFXSingleEventThread::onThreadEvent	(	FXObject *	,
		FXSelector	,
		void *
	)

inherited

Definition at line 128 of file MFXSingleEventThread.cpp.

References MFXInterThreadEventClient::eventOccurred(), and MFXSingleEventThread::myClient.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onThreadSignal()

long MFXSingleEventThread::onThreadSignal	(	FXObject *	,
		FXSelector	,
		void *
	)

inherited

Definition at line 113 of file MFXSingleEventThread.cpp.

References MFXSingleEventThread::event, PIPE_READ, FXEX::SEL_THREAD, and UNUSED_PARAMETER.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ prepareDestruction()

void GUIRunThread::prepareDestruction ( )

halts the thread before it shall be deleted

Definition at line 324 of file GUIRunThread.cpp.

References myHalting, and myQuit.

Referenced by GUIApplicationWindow::~GUIApplicationWindow().

Here is the caller graph for this function:

◆ resume()

void GUIRunThread::resume ( )

called when the user presses the "resume"-button

Note: this method resumes the execution after a break

Definition at line 257 of file GUIRunThread.cpp.

References myHalting, and mySingle.

Referenced by GUIApplicationWindow::onCmdStart().

Here is the caller graph for this function:

◆ retrieveMessage()

void GUIRunThread::retrieveMessage	(	const MsgHandler::MsgType	type,
		const std::string &	msg
	)

Retrieves messages from the loading module.

Definition at line 331 of file GUIRunThread.cpp.

References myEventQue, myEventThrow, MFXSynchQue< T, Container >::push_back(), and FXEX::MFXThreadEvent::signal().

Referenced by GUIRunThread().

Here is the caller graph for this function:

◆ run()

FXint GUIRunThread::run ( )

virtual

starts the execution

Reimplemented from MFXSingleEventThread.

Definition at line 126 of file GUIRunThread.cpp.

References deleteSim(), myAmLibsumo, MFXSingleEventThread::myApp, myQuit, and tryStep().

◆ signal() [1/2]

void MFXSingleEventThread::signal ( )

inherited

Definition at line 89 of file MFXSingleEventThread.cpp.

References MFXSingleEventThread::event, PIPE_WRITE, FXEX::SEL_THREAD, and UNUSED_PARAMETER.

◆ signal() [2/2]

void MFXSingleEventThread::signal ( FXuint seltype )

inherited

Definition at line 101 of file MFXSingleEventThread.cpp.

References MFXSingleEventThread::event, PIPE_WRITE, and UNUSED_PARAMETER.

◆ simulationIsStartable()

bool GUIRunThread::simulationIsStartable ( ) const

virtual

check if simulation is startable

Definition at line 339 of file GUIRunThread.cpp.

References myHalting, and myNet.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded(), GUIApplicationWindow::handleEvent_SimulationStep(), and GUIApplicationWindow::onUpdStart().

Here is the caller graph for this function:

◆ simulationIsStepable()

bool GUIRunThread::simulationIsStepable ( ) const

virtual

check if simulation is stepable

Definition at line 351 of file GUIRunThread.cpp.

References myHalting, and myNet.

Referenced by GUIApplicationWindow::onUpdStep().

Here is the caller graph for this function:

◆ simulationIsStopable()

bool GUIRunThread::simulationIsStopable ( ) const

virtual

check if simulation is stopableo

Definition at line 345 of file GUIRunThread.cpp.

References myHalting, and myNet.

Referenced by GUIApplicationWindow::onUpdStop().

Here is the caller graph for this function:

◆ singleStep()

void GUIRunThread::singleStep ( )

called when the user presses the "single step"-button

Note: this method allows the thread to perform a single simulation step

Definition at line 264 of file GUIRunThread.cpp.

References myHalting, and mySingle.

Referenced by GUIApplicationWindow::onCmdStep().

Here is the caller graph for this function:

◆ sleep()

void MFXSingleEventThread::sleep ( long ms )

staticinherited

Definition at line 142 of file MFXSingleEventThread.cpp.

Referenced by deleteSim(), GUIApplicationWindow::loadOnStartup(), GUISUMOAbstractView::makeSnapshot(), and tryStep().

Here is the caller graph for this function:

◆ stop()

void GUIRunThread::stop ( )

halts the simulation execution

Definition at line 279 of file GUIRunThread.cpp.

References myHalting, and mySingle.

Referenced by GUIApplicationWindow::onCmdStop(), and tryStep().

Here is the caller graph for this function:

◆ tryStep()

void GUIRunThread::tryStep ( )

try simulation step

Definition at line 143 of file GUIRunThread.cpp.

References DELTA_T, SysUtils::getCurrentMillis(), MSNet::getCurrentTimeStep(), getNet(), makeStep(), myBreakpointLock, myBreakpoints, myHalting, myLastBreakMillis, myLastEndMillis, myNet, myOk, mySimDelay, mySingle, GUINet::setIdleDuration(), GUINet::setSimDuration(), MFXSingleEventThread::sleep(), stop(), TS, and waitForSnapshots().

Referenced by run().

Here is the caller graph for this function:

◆ waitForSnapshots()

void GUIRunThread::waitForSnapshots ( const SUMOTime snapshotTime )

protected

wait for snapshots

Definition at line 357 of file GUIRunThread.cpp.

References GUIMainWindow::getInstance(), and GUIMainWindow::getViews().

Referenced by tryStep().

Here is the caller graph for this function:

Field Documentation

◆ event

FXEX::MFXThreadEventHandle MFXSingleEventThread::event

privateinherited

event

Definition at line 72 of file MFXSingleEventThread.h.

Referenced by MFXSingleEventThread::onThreadSignal(), MFXSingleEventThread::signal(), MFXSingleEventThread::signal(), and MFXSingleEventThread::~MFXSingleEventThread().

◆ myAmLibsumo

bool GUIRunThread::myAmLibsumo

protected

whether we are running in libsumo

Definition at line 199 of file GUIRunThread.h.

Referenced by enableLibsumo(), makeStep(), and run().

◆ myApp

FXApp* MFXSingleEventThread::myApp = nullptr

protectedinherited

pointer to APP

Definition at line 65 of file MFXSingleEventThread.h.

Referenced by run(), and MFXSingleEventThread::~MFXSingleEventThread().

◆ myBreakpointLock

FXMutex GUIRunThread::myBreakpointLock

protected

Lock for modifying the list of breakpoints.

Definition at line 190 of file GUIRunThread.h.

Referenced by getBreakpointLock(), and tryStep().

◆ myBreakpoints

std::vector<SUMOTime> GUIRunThread::myBreakpoints

protected

List of breakpoints.

Definition at line 187 of file GUIRunThread.h.

Referenced by getBreakpoints(), and tryStep().

◆ myClient

MFXInterThreadEventClient* MFXSingleEventThread::myClient = nullptr

protectedinherited

thread client

Definition at line 68 of file MFXSingleEventThread.h.

Referenced by MFXSingleEventThread::onThreadEvent().

◆ myErrorRetriever

OutputDevice* GUIRunThread::myErrorRetriever

protected

The instances of message retriever encapsulations.

Note: Needed to be deleted from the handler later on

Definition at line 172 of file GUIRunThread.h.

Referenced by deleteSim(), GUIRunThread(), init(), and ~GUIRunThread().

◆ myEventQue

MFXSynchQue<GUIEvent*>& GUIRunThread::myEventQue

protected

event queue

Definition at line 178 of file GUIRunThread.h.

Referenced by makeStep(), and retrieveMessage().

◆ myEventThrow

FXEX::MFXThreadEvent& GUIRunThread::myEventThrow

protected

thrower events

Definition at line 181 of file GUIRunThread.h.

Referenced by makeStep(), and retrieveMessage().

◆ myHalting

bool GUIRunThread::myHalting

protected

information whether the simulation is halting (is not being executed)

Definition at line 151 of file GUIRunThread.h.

Referenced by deleteSim(), init(), makeStep(), prepareDestruction(), resume(), simulationIsStartable(), simulationIsStepable(), simulationIsStopable(), singleStep(), stop(), and tryStep().

◆ myHaveSignaledEnd

bool GUIRunThread::myHaveSignaledEnd

protected

whether the simulation already ended

Definition at line 168 of file GUIRunThread.h.

Referenced by init(), and makeStep().

◆ myLastBreakMillis

long GUIRunThread::myLastBreakMillis

protected

last time the simulation took a microsecond break for the fox event loop to catch up (#9028)

Definition at line 196 of file GUIRunThread.h.

Referenced by tryStep().

◆ myLastEndMillis

long GUIRunThread::myLastEndMillis

protected

end of the last simulation step

Definition at line 193 of file GUIRunThread.h.

Referenced by tryStep().

◆ myMessageRetriever

OutputDevice * GUIRunThread::myMessageRetriever

protected

Definition at line 172 of file GUIRunThread.h.

Referenced by deleteSim(), GUIRunThread(), init(), and ~GUIRunThread().

◆ myNet

GUINet* GUIRunThread::myNet

protected

the loaded simulation network

Definition at line 145 of file GUIRunThread.h.

Referenced by deleteSim(), getNet(), init(), makeStep(), networkAvailable(), simulationIsStartable(), simulationIsStepable(), simulationIsStopable(), tryStep(), and ~GUIRunThread().

◆ myOk

bool GUIRunThread::myOk

protected

flag to check if all is ok

Definition at line 162 of file GUIRunThread.h.

Referenced by begin(), init(), makeStep(), and tryStep().

◆ myQuit

bool GUIRunThread::myQuit

protected

information whether the thread shall be stopped

Note: if not, the thread stays in an endless loop)

Definition at line 155 of file GUIRunThread.h.

Referenced by prepareDestruction(), run(), and ~GUIRunThread().

◆ mySimDelay

double& GUIRunThread::mySimDelay

protected

simulation delay

Definition at line 175 of file GUIRunThread.h.

Referenced by tryStep().

◆ mySimEndTime

SUMOTime GUIRunThread::mySimEndTime

protected

Definition at line 148 of file GUIRunThread.h.

Referenced by deleteSim(), getSimEndTime(), init(), and makeStep().

◆ mySimStartTime

SUMOTime GUIRunThread::mySimStartTime

protected

the times the simulation starts and ends with

Definition at line 148 of file GUIRunThread.h.

Referenced by begin(), deleteSim(), getSimBegin(), and init().

◆ mySimulationInProgress

bool GUIRunThread::mySimulationInProgress

protected

information whether a simulation step is being performed

Note: otherwise the thread may be waiting or the simulation is maybe not performed at all

Definition at line 159 of file GUIRunThread.h.

Referenced by deleteSim(), init(), makeStep(), and ~GUIRunThread().

◆ mySimulationLock

FXMutex GUIRunThread::mySimulationLock

protected

mutex for lock simulation

Definition at line 184 of file GUIRunThread.h.

Referenced by deleteSim(), init(), and makeStep().

◆ mySingle

bool GUIRunThread::mySingle

protected

information whether the thread is running in single step mode

Definition at line 165 of file GUIRunThread.h.

Referenced by resume(), singleStep(), stop(), and tryStep().

◆ myWarningRetriever

OutputDevice * GUIRunThread::myWarningRetriever

protected

Definition at line 172 of file GUIRunThread.h.

Referenced by deleteSim(), GUIRunThread(), init(), and ~GUIRunThread().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ GUIRunThread()

◆ ~GUIRunThread()

Member Function Documentation

◆ begin()

◆ deleteSim()

◆ enableLibsumo()

◆ getBreakpointLock()

◆ getBreakpoints()

◆ getNet()

◆ getSimBegin()

◆ getSimEndTime()

◆ init()

◆ makeStep()

◆ networkAvailable()

◆ onThreadEvent()

◆ onThreadSignal()

◆ prepareDestruction()

◆ resume()

◆ retrieveMessage()

◆ run()

◆ signal() [1/2]

◆ signal() [2/2]

◆ simulationIsStartable()

◆ simulationIsStepable()

◆ simulationIsStopable()

◆ singleStep()

◆ sleep()

◆ stop()

◆ tryStep()

◆ waitForSnapshots()

Field Documentation

◆ event

◆ myAmLibsumo

◆ myApp

◆ myBreakpointLock

◆ myBreakpoints

◆ myClient

◆ myErrorRetriever

◆ myEventQue

◆ myEventThrow

◆ myHalting

◆ myHaveSignaledEnd

◆ myLastBreakMillis

◆ myLastEndMillis

◆ myMessageRetriever

◆ myNet

◆ myOk

◆ myQuit

◆ mySimDelay

◆ mySimEndTime

◆ mySimStartTime

◆ mySimulationInProgress

◆ mySimulationLock

◆ mySingle

◆ myWarningRetriever