Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GUIRunThread Class Reference

#include <GUIRunThread.h>

Inheritance diagram for GUIRunThread:
[legend]
Collaboration diagram for GUIRunThread:
[legend]

Public Types

enum  { ID_THREAD_EVENT }
 FOX declaration. More...
 

Public Member Functions

virtual void begin ()
 
virtual void deleteSim ()
 
void enableLibsumo ()
 
FXMutex & getBreakpointLock ()
 
std::vector< SUMOTime > & getBreakpoints ()
 
GUINetgetNet () const
 
SUMOTimegetSimBegin ()
 
SUMOTime getSimEndTime () const
 
 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
 
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.
 
virtual FXint run ()
 starts the execution
 
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 ()
 
void tryStep ()
 
virtual ~GUIRunThread ()
 destructor
 

Static Public Member Functions

static void sleep (long ms)
 

Protected Member Functions

void makeStep ()
 
void waitForSnapshots (const SUMOTime snapshotTime)
 

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< SUMOTimemyBreakpoints
 List of breakpoints.
 
MFXInterThreadEventClientmyClient = nullptr
 thread client
 
OutputDevicemyErrorRetriever
 The instances of message retriever encapsulations Needed to be deleted from the handler later on.
 
MFXSynchQue< GUIEvent * > & myEventQue
 
FXEX::MFXThreadEventmyEventThrow
 
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
 
OutputDevicemyMessageRetriever
 
GUINetmyNet
 the loaded simulation network
 
bool myOk
 
bool myQuit
 
double & mySimDelay
 
SUMOTime mySimEndTime
 
SUMOTime mySimStartTime
 the times the simulation starts and ends with
 
bool mySimulationInProgress
 
FXMutex mySimulationLock
 
bool mySingle
 
OutputDevicemyWarningRetriever
 

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 54 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 
)

◆ ~GUIRunThread()

GUIRunThread::~GUIRunThread ( )
virtual

Member Function Documentation

◆ begin()

void GUIRunThread::begin ( )
virtual

starts the simulation (execution of one step after another)

Definition at line 263 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()

◆ enableLibsumo()

void GUIRunThread::enableLibsumo ( )
inline

Definition at line 119 of file GUIRunThread.h.

References myAmLibsumo.

◆ getBreakpointLock()

FXMutex & GUIRunThread::getBreakpointLock ( )
inline

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

Definition at line 107 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 310 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

Definition at line 115 of file GUIRunThread.h.

References mySimStartTime.

Referenced by GUIApplicationWindow::onCmdEditBreakpoints().

Here is the caller graph for this function:

◆ getSimEndTime()

SUMOTime GUIRunThread::getSimEndTime ( ) const
inline

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

◆ makeStep()

◆ 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 316 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, this method resumes the execution after a break

Definition at line 249 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 323 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 118 of file GUIRunThread.cpp.

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

◆ signal() [1/2]

void MFXSingleEventThread::signal ( )
inherited

◆ signal() [2/2]

void MFXSingleEventThread::signal ( FXuint  seltype)
inherited

◆ simulationAvailable()

bool GUIRunThread::simulationAvailable ( ) const

returns the information whether a simulation has been loaded

Definition at line 278 of file GUIRunThread.cpp.

References myNet.

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

Here is the caller graph for this function:

◆ simulationIsStartable()

bool GUIRunThread::simulationIsStartable ( ) const
virtual

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

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

Definition at line 337 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, this method allows the thread to perform a single simulation step

Definition at line 256 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 271 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 ( )

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

Definition at line 349 of file GUIRunThread.cpp.

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

Referenced by tryStep().

Here is the caller graph for this function:

Field Documentation

◆ event

◆ myAmLibsumo

bool GUIRunThread::myAmLibsumo
protected

whether we are running in libsumo

Definition at line 182 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 173 of file GUIRunThread.h.

Referenced by getBreakpointLock(), and tryStep().

◆ myBreakpoints

std::vector<SUMOTime> GUIRunThread::myBreakpoints
protected

List of breakpoints.

Definition at line 170 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 Needed to be deleted from the handler later on.

Definition at line 159 of file GUIRunThread.h.

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

◆ myEventQue

MFXSynchQue<GUIEvent*>& GUIRunThread::myEventQue
protected

Definition at line 163 of file GUIRunThread.h.

Referenced by makeStep(), and retrieveMessage().

◆ myEventThrow

FXEX::MFXThreadEvent& GUIRunThread::myEventThrow
protected

Definition at line 165 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 138 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 155 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 179 of file GUIRunThread.h.

Referenced by tryStep().

◆ myLastEndMillis

long GUIRunThread::myLastEndMillis
protected

end of the last simulation step

Definition at line 176 of file GUIRunThread.h.

Referenced by tryStep().

◆ myMessageRetriever

OutputDevice * GUIRunThread::myMessageRetriever
protected

Definition at line 159 of file GUIRunThread.h.

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

◆ myNet

GUINet* GUIRunThread::myNet
protected

◆ myOk

bool GUIRunThread::myOk
protected

Definition at line 149 of file GUIRunThread.h.

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

◆ myQuit

bool GUIRunThread::myQuit
protected

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

Definition at line 142 of file GUIRunThread.h.

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

◆ mySimDelay

double& GUIRunThread::mySimDelay
protected

Definition at line 161 of file GUIRunThread.h.

Referenced by tryStep().

◆ mySimEndTime

SUMOTime GUIRunThread::mySimEndTime
protected

Definition at line 135 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 135 of file GUIRunThread.h.

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

◆ mySimulationInProgress

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

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

◆ mySimulationLock

FXMutex GUIRunThread::mySimulationLock
protected

Definition at line 167 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 152 of file GUIRunThread.h.

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

◆ myWarningRetriever

OutputDevice * GUIRunThread::myWarningRetriever
protected

Definition at line 159 of file GUIRunThread.h.

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


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