Eclipse SUMO - Simulation of Urban MObility
GUIRunThread.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
16 // The thread that runs the simulation
17 /****************************************************************************/
18 #ifndef GUIRunThread_h
19 #define GUIRunThread_h
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 #include <string>
28 #include <vector>
29 #include <set>
30 #include <iostream>
31 #include <fx.h>
35 #include <utils/common/SUMOTime.h>
36 
37 
38 // ===========================================================================
39 // class declarations
40 // ===========================================================================
41 class GUINet;
42 class GUIEvent;
43 class OutputDevice;
44 
45 
46 // ===========================================================================
47 // class definition
48 // ===========================================================================
57 public:
60  double& simDelay, FXSynchQue<GUIEvent*>& eq, FXEX::FXThreadEvent& ev);
61 
63  virtual ~GUIRunThread();
64 
66  virtual bool init(GUINet* net, SUMOTime start, SUMOTime end);
67 
69  virtual FXint run();
70 
73  void resume();
74 
77  void singleStep();
78 
80  virtual void begin();
81 
83  void stop();
84 
86  bool simulationAvailable() const;
87 
88  virtual bool simulationIsStartable() const;
89  virtual bool simulationIsStopable() const;
90  virtual bool simulationIsStepable() const;
91 
93  virtual void deleteSim();
94 
96  GUINet& getNet() const;
97 
99  void prepareDestruction();
100 
102  void retrieveMessage(const MsgHandler::MsgType type, const std::string& msg);
103 
105  return mySimEndTime;
106  }
107 
108  std::vector<SUMOTime>& getBreakpoints() {
109  return myBreakpoints;
110  }
111 
112  FXMutex& getBreakpointLock() {
113  return myBreakpointLock;
114  }
115 
116 protected:
117  void makeStep();
118 
119  void waitForSnapshots(const SUMOTime snapshotTime);
120 
121 protected:
124 
127 
129  bool myHalting;
130 
133  bool myQuit;
134 
139 
140  bool myOk;
141 
143  bool mySingle;
144 
147 
151 
152  double& mySimDelay;
153 
155 
157 
159 
161  std::vector<SUMOTime> myBreakpoints;
162 
165 
166 };
167 
168 
169 #endif
170 
171 /****************************************************************************/
MsgHandler::MsgType
MsgType
Definition: MsgHandler.h:45
GUIRunThread::mySimStartTime
SUMOTime mySimStartTime
the times the simulation starts and ends with
Definition: GUIRunThread.h:126
GUIRunThread::simulationIsStopable
virtual bool simulationIsStopable() const
Definition: GUIRunThread.cpp:328
MFXInterThreadEventClient
Definition: MFXInterThreadEventClient.h:27
GUIRunThread::singleStep
void singleStep()
Definition: GUIRunThread.cpp:251
SUMOTime.h
GUIRunThread::myBreakpointLock
FXMutex myBreakpointLock
Lock for modifying the list of breakpoints.
Definition: GUIRunThread.h:164
OutputDevice
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:63
GUIRunThread::makeStep
void makeStep()
Definition: GUIRunThread.cpp:159
GUIRunThread::myHaveSignaledEnd
bool myHaveSignaledEnd
whether the simulation already ended
Definition: GUIRunThread.h:146
GUIRunThread::begin
virtual void begin()
Definition: GUIRunThread.cpp:258
GUIRunThread::mySingle
bool mySingle
Definition: GUIRunThread.h:143
SUMOTime
long long int SUMOTime
Definition: SUMOTime.h:34
GUIRunThread::myOk
bool myOk
Definition: GUIRunThread.h:140
GUIRunThread::getBreakpoints
std::vector< SUMOTime > & getBreakpoints()
Definition: GUIRunThread.h:108
GUIRunThread
Definition: GUIRunThread.h:56
GUIRunThread::~GUIRunThread
virtual ~GUIRunThread()
destructor
Definition: GUIRunThread.cpp:64
GUIRunThread::retrieveMessage
void retrieveMessage(const MsgHandler::MsgType type, const std::string &msg)
Retrieves messages from the loading module.
Definition: GUIRunThread.cpp:314
GUIRunThread::myHalting
bool myHalting
information whether the simulation is halting (is not being executed)
Definition: GUIRunThread.h:129
GUIRunThread::mySimEndTime
SUMOTime mySimEndTime
Definition: GUIRunThread.h:126
GUIRunThread::simulationIsStartable
virtual bool simulationIsStartable() const
Definition: GUIRunThread.cpp:322
FXSynchQue.h
GUIRunThread::mySimDelay
double & mySimDelay
Definition: GUIRunThread.h:152
GUIRunThread::getBreakpointLock
FXMutex & getBreakpointLock()
Definition: GUIRunThread.h:112
GUIRunThread::simulationAvailable
bool simulationAvailable() const
Definition: GUIRunThread.cpp:273
GUIRunThread::mySimulationInProgress
bool mySimulationInProgress
Definition: GUIRunThread.h:138
GUIRunThread::mySimulationLock
FXMutex mySimulationLock
Definition: GUIRunThread.h:158
GUIRunThread::getNet
GUINet & getNet() const
Definition: GUIRunThread.cpp:301
GUIRunThread::myWarningRetriever
OutputDevice * myWarningRetriever
Definition: GUIRunThread.h:150
GUIRunThread::myNet
GUINet * myNet
the loaded simulation network
Definition: GUIRunThread.h:123
GUIRunThread::simulationIsStepable
virtual bool simulationIsStepable() const
Definition: GUIRunThread.cpp:334
FXSingleEventThread.h
GUIRunThread::resume
void resume()
Definition: GUIRunThread.cpp:244
GUIRunThread::myMessageRetriever
OutputDevice * myMessageRetriever
Definition: GUIRunThread.h:150
GUIRunThread::myQuit
bool myQuit
Definition: GUIRunThread.h:133
GUIRunThread::stop
void stop()
Definition: GUIRunThread.cpp:266
GUIRunThread::myErrorRetriever
OutputDevice * myErrorRetriever
The instances of message retriever encapsulations Needed to be deleted from the handler later on.
Definition: GUIRunThread.h:150
GUIRunThread::myBreakpoints
std::vector< SUMOTime > myBreakpoints
List of breakpoints.
Definition: GUIRunThread.h:161
GUIRunThread::waitForSnapshots
void waitForSnapshots(const SUMOTime snapshotTime)
Definition: GUIRunThread.cpp:340
FXSynchQue< GUIEvent * >
GUIRunThread::myEventQue
FXSynchQue< GUIEvent * > & myEventQue
Definition: GUIRunThread.h:154
GUIEvent
Definition: GUIEvent.h:76
GUIRunThread::myEventThrow
FXEX::FXThreadEvent & myEventThrow
Definition: GUIRunThread.h:156
GUIRunThread::getSimEndTime
SUMOTime getSimEndTime() const
Definition: GUIRunThread.h:104
FXThreadEvent.h
config.h
FXSingleEventThread
Definition: FXSingleEventThread.h:34
FXEX::FXThreadEvent
Definition: FXThreadEvent.h:105
GUINet
A MSNet extended by some values for usage within the gui.
Definition: GUINet.h:82
GUIRunThread::run
virtual FXint run()
starts the execution
Definition: GUIRunThread.cpp:117
GUIRunThread::deleteSim
virtual void deleteSim()
Definition: GUIRunThread.cpp:279
GUIRunThread::init
virtual bool init(GUINet *net, SUMOTime start, SUMOTime end)
initialises the thread with the new simulation
Definition: GUIRunThread.cpp:77
GUIRunThread::prepareDestruction
void prepareDestruction()
Definition: GUIRunThread.cpp:307
GUIRunThread::GUIRunThread
GUIRunThread(FXApp *app, MFXInterThreadEventClient *mw, double &simDelay, FXSynchQue< GUIEvent * > &eq, FXEX::FXThreadEvent &ev)
constructor
Definition: GUIRunThread.cpp:52