#include <GUIRunThread.h>

Inheritance diagram for GUIRunThread:

Collaboration diagram for GUIRunThread:

Public Types
enum	{ ID_THREAD_EVENT }

Public Member Functions
virtual void	begin ()

virtual void	deleteSim ()

FXMutex &	getBreakpointLock ()

std::vector< SUMOTime > &	getBreakpoints ()

GUINet &	getNet () const

SUMOTime	getSimEndTime () const

std::set< SUMOTime > &	getSnapshots ()

FXMutex &	getSnapshotsLock ()

	GUIRunThread (FXApp app, MFXInterThreadEventClient mw, FXRealSpinDial &simDelay, MFXEventQue< GUIEvent * > &eq, FXEX::FXThreadEvent &ev)
	constructor More...

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

long	onThreadEvent (FXObject , FXSelector, void )

long	onThreadSignal (FXObject , FXSelector, void )

void	prepareDestruction ()

void	resume ()

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

virtual FXint	run ()
	starts the execution More...

void	signal ()

void	signal (FXuint seltype)

bool	simulationAvailable () const

virtual bool	simulationIsStartable () const

virtual bool	simulationIsStepable () const

virtual bool	simulationIsStopable () const

void	singleStep ()

void	stop ()

virtual	~GUIRunThread ()
	destructor More...

Static Public Member Functions
static void	sleep (long ms)

Protected Member Functions
void	makeStep ()

void	waitForSnapshots (SUMOTime snapShotTime)

Protected Attributes
std::set< SUMOTime >	myApplicationSnapshots
	List of snapshot times. More...

FXMutex	myApplicationSnapshotsLock
	Lock for modifying the list of snapshot times. More...

FXMutex	myBreakpointLock
	Lock for modifying the list of breakpoints. More...

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

OutputDevice *	myErrorRetriever
	The instances of message retriever encapsulations Needed to be deleted from the handler later on. More...

MFXEventQue< GUIEvent * > &	myEventQue

FXEX::FXThreadEvent &	myEventThrow

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

bool	myHaveSignaledEnd
	whether the simulation already ended More...

OutputDevice *	myMessageRetriever

GUINet *	myNet
	the loaded simulation network More...

bool	myOk

bool	myQuit

FXRealSpinDial &	mySimDelay

SUMOTime	mySimEndTime

SUMOTime	mySimStartTime
	the times the simulation starts and ends with More...

bool	mySimulationInProgress

MFXMutex	mySimulationLock

bool	mySingle

OutputDevice *	myWarningRetriever

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 63 of file GUIRunThread.h.

Member Enumeration Documentation

anonymous enum

inherited

Enumerator
ID_THREAD_EVENT

Definition at line 53 of file FXSingleEventThread.h.

Constructor & Destructor Documentation

GUIRunThread::GUIRunThread	(	FXApp *	app,
		MFXInterThreadEventClient *	mw,
		FXRealSpinDial &	simDelay,
		MFXEventQue< GUIEvent * > &	eq,
		FXEX::FXThreadEvent &	ev
	)

constructor

Definition at line 63 of file GUIRunThread.cpp.

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

GUIRunThread::~GUIRunThread ( )

virtual

destructor

Definition at line 75 of file GUIRunThread.cpp.

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

Member Function Documentation

void GUIRunThread::begin ( )

virtual

starts the simulation (execution of one step after another)

Definition at line 270 of file GUIRunThread.cpp.

References myOk, mySimStartTime, time2string(), and WRITE_MESSAGE.

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

void GUIRunThread::deleteSim ( )

virtual

deletes the existing simulation

Definition at line 291 of file GUIRunThread.cpp.

References MsgHandler::cleanupOnEnd(), GUIGlObjectStorage::clear(), OutputDevice::closeAll(), MSNet::closeSimulation(), MsgHandler::getErrorInstance(), MsgHandler::getMessageInstance(), MsgHandler::getWarningInstance(), GUIGlObjectStorage::gIDStorage, MFXMutex::lock(), myErrorRetriever, myHalting, myMessageRetriever, myNet, mySimStartTime, mySimulationInProgress, mySimulationLock, myWarningRetriever, MsgHandler::removeRetriever(), and MFXMutex::unlock().

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

FXMutex& GUIRunThread::getBreakpointLock ( )

inline

Definition at line 119 of file GUIRunThread.h.

References myBreakpointLock.

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

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

inline

Definition at line 115 of file GUIRunThread.h.

References myBreakpoints.

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

GUINet & GUIRunThread::getNet ( ) const

returns the loaded network

Definition at line 313 of file GUIRunThread.cpp.

References myNet.

Referenced by GUIApplicationWindow::getCurrentSimTime(), GUIApplicationWindow::handleEvent_SimulationStep(), GUIApplicationWindow::onCmdOpenShapes(), GUIApplicationWindow::onCmdTimeToggle(), GUIApplicationWindow::openNewView(), and run().

SUMOTime GUIRunThread::getSimEndTime ( ) const

inline

Definition at line 111 of file GUIRunThread.h.

References mySimEndTime.

Referenced by GUIApplicationWindow::updateTimeLCD().

std::set<SUMOTime>& GUIRunThread::getSnapshots ( )

inline

Definition at line 123 of file GUIRunThread.h.

References myApplicationSnapshots.

Referenced by GUIApplicationWindow::openNewView().

FXMutex& GUIRunThread::getSnapshotsLock ( )

inline

Definition at line 127 of file GUIRunThread.h.

References makeStep(), myApplicationSnapshotsLock, and waitForSnapshots().

Referenced by GUIApplicationWindow::openNewView().

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

virtual

initialises the thread with the new simulation

Definition at line 88 of file GUIRunThread.cpp.

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

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded().

void GUIRunThread::makeStep ( )

protected

Definition at line 173 of file GUIRunThread.cpp.

References MFXEventQue< T >::add(), DELTA_T, MSNet::getCurrentTimeStep(), MsgHandler::getErrorInstance(), TraCIServer::getInstance(), TraCI::getLoadArgs(), MSNet::getStateMessage(), GUINet::guiSimulationStep(), MsgHandler::inform(), MFXMutex::lock(), myEventQue, myEventThrow, myHalting, myHaveSignaledEnd, myNet, myOk, mySimEndTime, mySimulationInProgress, mySimulationLock, mySingle, OptionsIO::setArgs(), FXEX::FXThreadEvent::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_RUNNING, MSNet::SIMSTATE_TOO_MANY_TELEPORTS, MSNet::simulationState(), GUINet::simulationStep(), time2string(), MFXMutex::unlock(), TraCIServer::wasClosed(), WRITE_ERROR, and WRITE_MESSAGE.

Referenced by getSnapshotsLock(), and run().

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

inherited

Definition at line 129 of file FXSingleEventThread.cpp.

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

inherited

Definition at line 115 of file FXSingleEventThread.cpp.

References PIPE_READ, and FXEX::SEL_THREAD.

void GUIRunThread::prepareDestruction ( )

halts the thread before it shall be deleted

Definition at line 319 of file GUIRunThread.cpp.

References myHalting, and myQuit.

Referenced by GUIApplicationWindow::~GUIApplicationWindow().

void GUIRunThread::resume ( )

called when the user presses the "resume"-button, this method resumes the execution after a break

Definition at line 256 of file GUIRunThread.cpp.

References myHalting, and mySingle.

Referenced by GUIApplicationWindow::onCmdStart().

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

Retrieves messages from the loading module.

Definition at line 326 of file GUIRunThread.cpp.

References MFXEventQue< T >::add(), myEventQue, myEventThrow, and FXEX::FXThreadEvent::signal().

Referenced by GUIRunThread().

FXint GUIRunThread::run ( )

virtual

starts the execution

Reimplemented from FXSingleEventThread.

Definition at line 127 of file GUIRunThread.cpp.

References deleteSim(), DELTA_T, SysUtils::getCurrentMillis(), MSNet::getCurrentTimeStep(), getNet(), FX::FXRealSpinDial::getValue(), makeStep(), myBreakpointLock, myBreakpoints, myHalting, myNet, myOk, myQuit, mySimDelay, GUINet::setIdleDuration(), GUINet::setSimDuration(), FXSingleEventThread::sleep(), stop(), and waitForSnapshots().

void FXSingleEventThread::signal ( )

inherited

Definition at line 93 of file FXSingleEventThread.cpp.

References PIPE_WRITE, and FXEX::SEL_THREAD.

void FXSingleEventThread::signal ( FXuint seltype )

inherited

Definition at line 104 of file FXSingleEventThread.cpp.

References PIPE_WRITE, and UNUSED_PARAMETER.

bool GUIRunThread::simulationAvailable ( ) const

returns the information whether a simulation has been loaded

Definition at line 285 of file GUIRunThread.cpp.

References myNet.

Referenced by GUIApplicationWindow::eventOccured(), GUIApplicationWindow::onCmdEditChosen(), GUIApplicationWindow::onCmdStart(), GUIApplicationWindow::onCmdStep(), GUIApplicationWindow::onCmdTimeToggle(), GUIApplicationWindow::onUpdAddView(), GUIApplicationWindow::onUpdNeedsSimulation(), and GUIApplicationWindow::openNewView().

bool GUIRunThread::simulationIsStartable ( ) const

virtual

Definition at line 334 of file GUIRunThread.cpp.

References myHalting, and myNet.

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

bool GUIRunThread::simulationIsStepable ( ) const

virtual

Definition at line 346 of file GUIRunThread.cpp.

References myHalting, and myNet.

Referenced by GUIApplicationWindow::onUpdStep().

bool GUIRunThread::simulationIsStopable ( ) const

virtual

Definition at line 340 of file GUIRunThread.cpp.

References myHalting, and myNet.

Referenced by GUIApplicationWindow::onUpdStop().

void GUIRunThread::singleStep ( )

called when the user presses the "single step"-button, this method allows the thread to perform a single simulation step

Definition at line 263 of file GUIRunThread.cpp.

References myHalting, and mySingle.

Referenced by GUIApplicationWindow::onCmdStep().

void FXSingleEventThread::sleep ( long ms )

staticinherited

Definition at line 143 of file FXSingleEventThread.cpp.

Referenced by GUISUMOAbstractView::makeSnapshot(), FXSingleEventThread::run(), run(), and waitForSnapshots().

void GUIRunThread::stop ( )

halts the simulation execution

Definition at line 278 of file GUIRunThread.cpp.

References myHalting, and mySingle.

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

void GUIRunThread::waitForSnapshots ( SUMOTime snapShotTime )

protected

Definition at line 352 of file GUIRunThread.cpp.

References myApplicationSnapshots, myApplicationSnapshotsLock, myHalting, and FXSingleEventThread::sleep().

Referenced by getSnapshotsLock(), and run().

Field Documentation

std::set<SUMOTime> GUIRunThread::myApplicationSnapshots

protected

List of snapshot times.

Definition at line 182 of file GUIRunThread.h.

Referenced by getSnapshots(), and waitForSnapshots().

FXMutex GUIRunThread::myApplicationSnapshotsLock

protected

Lock for modifying the list of snapshot times.

Definition at line 185 of file GUIRunThread.h.

Referenced by getSnapshotsLock(), and waitForSnapshots().

FXMutex GUIRunThread::myBreakpointLock

protected

Lock for modifying the list of breakpoints.

Definition at line 179 of file GUIRunThread.h.

Referenced by getBreakpointLock(), and run().

std::vector<SUMOTime> GUIRunThread::myBreakpoints

protected

List of breakpoints.

Definition at line 176 of file GUIRunThread.h.

Referenced by getBreakpoints(), and run().

OutputDevice* GUIRunThread::myErrorRetriever

protected

The instances of message retriever encapsulations Needed to be deleted from the handler later on.

Definition at line 165 of file GUIRunThread.h.

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

MFXEventQue<GUIEvent*>& GUIRunThread::myEventQue

protected

Definition at line 169 of file GUIRunThread.h.

Referenced by makeStep(), and retrieveMessage().

FXEX::FXThreadEvent& GUIRunThread::myEventThrow

protected

Definition at line 171 of file GUIRunThread.h.

Referenced by makeStep(), and retrieveMessage().

bool GUIRunThread::myHalting

protected

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

Definition at line 144 of file GUIRunThread.h.

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

bool GUIRunThread::myHaveSignaledEnd

protected

whether the simulation already ended

Definition at line 161 of file GUIRunThread.h.

Referenced by makeStep().

OutputDevice * GUIRunThread::myMessageRetriever

protected

Definition at line 165 of file GUIRunThread.h.

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

GUINet* GUIRunThread::myNet

protected

the loaded simulation network

Definition at line 138 of file GUIRunThread.h.

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

bool GUIRunThread::myOk

protected

Definition at line 155 of file GUIRunThread.h.

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

bool GUIRunThread::myQuit

protected

information whether the thread shall be stopped (if not, the thread stays in an endless loop)

Definition at line 148 of file GUIRunThread.h.

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

FXRealSpinDial& GUIRunThread::mySimDelay

protected

Definition at line 167 of file GUIRunThread.h.

Referenced by run().

SUMOTime GUIRunThread::mySimEndTime

protected

Definition at line 141 of file GUIRunThread.h.

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

SUMOTime GUIRunThread::mySimStartTime

protected

the times the simulation starts and ends with

Definition at line 141 of file GUIRunThread.h.

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

bool GUIRunThread::mySimulationInProgress

protected

information whether a simulation step is being performed (otherwise the thread may be waiting or the simulation is maybe not performed at all)

Definition at line 153 of file GUIRunThread.h.

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

MFXMutex GUIRunThread::mySimulationLock

protected

Definition at line 173 of file GUIRunThread.h.

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

bool GUIRunThread::mySingle

protected

information whether the thread is running in single step mode

Definition at line 158 of file GUIRunThread.h.

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

OutputDevice * GUIRunThread::myWarningRetriever

protected

Definition at line 165 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

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation