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 /****************************************************************************/
17 // The thread that runs the simulation
18 /****************************************************************************/
19 #ifndef GUIRunThread_h
20 #define GUIRunThread_h
21 
22 
23 // ===========================================================================
24 // included modules
25 // ===========================================================================
26 #include <config.h>
27 
28 #include <string>
29 #include <vector>
30 #include <set>
31 #include <iostream>
32 #include <fx.h>
36 #include <utils/common/SUMOTime.h>
37 
38 
39 // ===========================================================================
40 // class declarations
41 // ===========================================================================
42 class GUINet;
43 class GUIEvent;
44 class OutputDevice;
45 
46 
47 // ===========================================================================
48 // class definition
49 // ===========================================================================
58 public:
61  double& simDelay, FXSynchQue<GUIEvent*>& eq, FXEX::FXThreadEvent& ev);
62 
64  virtual ~GUIRunThread();
65 
67  virtual bool init(GUINet* net, SUMOTime start, SUMOTime end);
68 
70  virtual FXint run();
71 
74  void resume();
75 
78  void singleStep();
79 
81  virtual void begin();
82 
84  void stop();
85 
87  bool simulationAvailable() const;
88 
89  virtual bool simulationIsStartable() const;
90  virtual bool simulationIsStopable() const;
91  virtual bool simulationIsStepable() const;
92 
94  virtual void deleteSim();
95 
97  GUINet& getNet() const;
98 
100  void prepareDestruction();
101 
103  void retrieveMessage(const MsgHandler::MsgType type, const std::string& msg);
104 
106  return mySimEndTime;
107  }
108 
109  std::vector<SUMOTime>& getBreakpoints() {
110  return myBreakpoints;
111  }
112 
113  FXMutex& getBreakpointLock() {
114  return myBreakpointLock;
115  }
116 
117 protected:
118  void makeStep();
119 
120  void waitForSnapshots(const SUMOTime snapshotTime);
121 
122 protected:
125 
128 
130  bool myHalting;
131 
134  bool myQuit;
135 
140 
141  bool myOk;
142 
144  bool mySingle;
145 
148 
152 
153  double& mySimDelay;
154 
156 
158 
160 
162  std::vector<SUMOTime> myBreakpoints;
163 
166 
167 };
168 
169 
170 #endif
171 
172 /****************************************************************************/
MsgHandler::MsgType
MsgType
Definition: MsgHandler.h:51
GUIRunThread::mySimStartTime
SUMOTime mySimStartTime
the times the simulation starts and ends with
Definition: GUIRunThread.h:127
GUIRunThread::simulationIsStopable
virtual bool simulationIsStopable() const
Definition: GUIRunThread.cpp:329
MFXInterThreadEventClient
Definition: MFXInterThreadEventClient.h:28
GUIRunThread::singleStep
void singleStep()
Definition: GUIRunThread.cpp:252
SUMOTime.h
GUIRunThread::myBreakpointLock
FXMutex myBreakpointLock
Lock for modifying the list of breakpoints.
Definition: GUIRunThread.h:165
OutputDevice
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:64
GUIRunThread::makeStep
void makeStep()
Definition: GUIRunThread.cpp:160
GUIRunThread::myHaveSignaledEnd
bool myHaveSignaledEnd
whether the simulation already ended
Definition: GUIRunThread.h:147
GUIRunThread::begin
virtual void begin()
Definition: GUIRunThread.cpp:259
GUIRunThread::mySingle
bool mySingle
Definition: GUIRunThread.h:144
SUMOTime
long long int SUMOTime
Definition: SUMOTime.h:35
GUIRunThread::myOk
bool myOk
Definition: GUIRunThread.h:141
GUIRunThread::getBreakpoints
std::vector< SUMOTime > & getBreakpoints()
Definition: GUIRunThread.h:109
GUIRunThread
Definition: GUIRunThread.h:57
GUIRunThread::~GUIRunThread
virtual ~GUIRunThread()
destructor
Definition: GUIRunThread.cpp:65
GUIRunThread::retrieveMessage
void retrieveMessage(const MsgHandler::MsgType type, const std::string &msg)
Retrieves messages from the loading module.
Definition: GUIRunThread.cpp:315
GUIRunThread::myHalting
bool myHalting
information whether the simulation is halting (is not being executed)
Definition: GUIRunThread.h:130
GUIRunThread::mySimEndTime
SUMOTime mySimEndTime
Definition: GUIRunThread.h:127
GUIRunThread::simulationIsStartable
virtual bool simulationIsStartable() const
Definition: GUIRunThread.cpp:323
FXSynchQue.h
GUIRunThread::mySimDelay
double & mySimDelay
Definition: GUIRunThread.h:153
GUIRunThread::getBreakpointLock
FXMutex & getBreakpointLock()
Definition: GUIRunThread.h:113
GUIRunThread::simulationAvailable
bool simulationAvailable() const
Definition: GUIRunThread.cpp:274
GUIRunThread::mySimulationInProgress
bool mySimulationInProgress
Definition: GUIRunThread.h:139
GUIRunThread::mySimulationLock
FXMutex mySimulationLock
Definition: GUIRunThread.h:159
GUIRunThread::getNet
GUINet & getNet() const
Definition: GUIRunThread.cpp:302
GUIRunThread::myWarningRetriever
OutputDevice * myWarningRetriever
Definition: GUIRunThread.h:151
GUIRunThread::myNet
GUINet * myNet
the loaded simulation network
Definition: GUIRunThread.h:124
GUIRunThread::simulationIsStepable
virtual bool simulationIsStepable() const
Definition: GUIRunThread.cpp:335
FXSingleEventThread.h
GUIRunThread::resume
void resume()
Definition: GUIRunThread.cpp:245
GUIRunThread::myMessageRetriever
OutputDevice * myMessageRetriever
Definition: GUIRunThread.h:151
GUIRunThread::myQuit
bool myQuit
Definition: GUIRunThread.h:134
GUIRunThread::stop
void stop()
Definition: GUIRunThread.cpp:267
GUIRunThread::myErrorRetriever
OutputDevice * myErrorRetriever
The instances of message retriever encapsulations Needed to be deleted from the handler later on.
Definition: GUIRunThread.h:151
GUIRunThread::myBreakpoints
std::vector< SUMOTime > myBreakpoints
List of breakpoints.
Definition: GUIRunThread.h:162
GUIRunThread::waitForSnapshots
void waitForSnapshots(const SUMOTime snapshotTime)
Definition: GUIRunThread.cpp:341
FXSynchQue< GUIEvent * >
GUIRunThread::myEventQue
FXSynchQue< GUIEvent * > & myEventQue
Definition: GUIRunThread.h:155
GUIEvent
Definition: GUIEvent.h:77
GUIRunThread::myEventThrow
FXEX::FXThreadEvent & myEventThrow
Definition: GUIRunThread.h:157
GUIRunThread::getSimEndTime
SUMOTime getSimEndTime() const
Definition: GUIRunThread.h:105
FXThreadEvent.h
config.h
FXSingleEventThread
Definition: FXSingleEventThread.h:35
FXEX::FXThreadEvent
Definition: FXThreadEvent.h:106
GUINet
A MSNet extended by some values for usage within the gui.
Definition: GUINet.h:83
GUIRunThread::run
virtual FXint run()
starts the execution
Definition: GUIRunThread.cpp:118
GUIRunThread::deleteSim
virtual void deleteSim()
Definition: GUIRunThread.cpp:280
GUIRunThread::init
virtual bool init(GUINet *net, SUMOTime start, SUMOTime end)
initialises the thread with the new simulation
Definition: GUIRunThread.cpp:78
GUIRunThread::prepareDestruction
void prepareDestruction()
Definition: GUIRunThread.cpp:308
GUIRunThread::GUIRunThread
GUIRunThread(FXApp *app, MFXInterThreadEventClient *mw, double &simDelay, FXSynchQue< GUIEvent * > &eq, FXEX::FXThreadEvent &ev)
constructor
Definition: GUIRunThread.cpp:53