SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GUIRunThread.cpp
Go to the documentation of this file.
1 /****************************************************************************/
9 // The thread that runs the simulation
10 /****************************************************************************/
11 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
12 // Copyright (C) 2001-2013 DLR (http://www.dlr.de/) and contributors
13 /****************************************************************************/
14 //
15 // This file is part of SUMO.
16 // SUMO is free software: you can redistribute it and/or modify
17 // it under the terms of the GNU General Public License as published by
18 // the Free Software Foundation, either version 3 of the License, or
19 // (at your option) any later version.
20 //
21 /****************************************************************************/
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 #ifdef _MSC_VER
28 #include <windows_config.h>
29 #else
30 #include <config.h>
31 #endif
32 
33 #include <cassert>
34 #include <string>
35 #include <iostream>
36 #include <algorithm>
37 
38 #include <guisim/GUINet.h>
42 #include "GUIApplicationWindow.h"
43 #include "GUIRunThread.h"
44 #include "GUIGlobals.h"
47 #include <utils/common/SysUtils.h>
52 
53 #ifndef NO_TRACI
55 #endif
56 
57 #ifdef CHECK_MEMORY_LEAKS
58 #include <foreign/nvwa/debug_new.h>
59 #endif // CHECK_MEMORY_LEAKS
60 
61 
62 // ===========================================================================
63 // used namespaces
64 // ===========================================================================
65 using namespace FXEX;
66 using namespace std;
67 
68 
69 // ===========================================================================
70 // member method definitions
71 // ===========================================================================
73  FXRealSpinDial& simDelay, MFXEventQue& eq,
75  : FXSingleEventThread(app, parent),
76  myNet(0), myHalting(true), myQuit(false), mySimulationInProgress(false), myOk(true),
77  mySimDelay(simDelay), myEventQue(eq), myEventThrow(ev) {
81 }
82 
83 
85  // the thread shall stop
86  myQuit = true;
87  deleteSim();
88  delete myErrorRetriever;
89  delete myMessageRetriever;
90  delete myWarningRetriever;
91  // wait for the thread
92  while (mySimulationInProgress || myNet != 0);
93 }
94 
95 
96 bool
98  assert(net != 0);
99  // assign new values
100  myNet = net;
101  mySimStartTime = start;
102  mySimEndTime = end;
103  // register message callbacks
107  // preload the routes especially for TraCI
109  try {
110  net->loadRoutes();
111  } catch (ProcessError& e2) {
112  if (string(e2.what()) != string("Process Error") && std::string(e2.what()) != string("")) {
113  WRITE_ERROR(e2.what());
114  }
115  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
116  myHalting = true;
117  myOk = false;
118  mySimulationInProgress = false;
119 #ifndef _DEBUG
120  } catch (...) {
121  myHalting = true;
122  myOk = false;
123  mySimulationInProgress = false;
124 #endif
125  }
127  return myOk;
128 }
129 
130 
131 FXint
133  long beg = 0;
134  long end = -1;
135  // perform an endless loop
136  while (!myQuit) {
137  // if the simulation shall be perfomed, do it
138  if (!myHalting && myNet != 0 && myOk) {
139  if (getNet().logSimulationDuration()) {
141  if (end != -1) {
142  getNet().setIdleDuration((int)(beg - end));
143  }
144  }
145  // check whether we shall stop at this step
147  // do the step
148  makeStep();
149  // stop if wished
150  if (haltAfter) {
151  stop();
152  }
153  // wait if wanted
154  long wait = (long) mySimDelay.getValue();
155  if (getNet().logSimulationDuration()) {
157  getNet().setSimDuration((int)(end - beg));
158  wait -= (end - beg);
159  }
160  if (wait > 0) {
161  sleep(wait);
162  }
163  } else {
164  // sleep if the simulation is not running
165  sleep(500);
166  }
167  }
168  // delete a maybe existing simulation at the end
169  deleteSim();
170  return 0;
171 }
172 
173 
174 void
176  GUIEvent* e = 0;
177  // simulation is being perfomed
178  mySimulationInProgress = true;
179  // execute a single step
180  try {
185 
186  // inform parent that a step has been performed
187  e = new GUIEvent_SimulationStep();
188  myEventQue.add(e);
190 
191  e = 0;
193 #ifndef NO_TRACI
194  if (state != MSNet::SIMSTATE_RUNNING) {
195  if (OptionsCont::getOptions().getInt("remote-port") != 0 && !traci::TraCIServer::wasClosed()) {
196  state = MSNet::SIMSTATE_RUNNING;
197  }
198  }
199 #endif
200  switch (state) {
205  WRITE_MESSAGE("Simulation ended at time: " + time2string(myNet->getCurrentTimeStep()));
206  WRITE_MESSAGE("Reason: " + MSNet::getStateMessage(state));
208  break;
209  default:
210  break;
211  }
212  if (e != 0) {
213  myEventQue.add(e);
215  myHalting = true;
216  }
217  // stop the execution when only a single step should have
218  // been performed
219  if (mySingle) {
220  myHalting = true;
221  }
222  // simulation step is over
223  mySimulationInProgress = false;
224  } catch (ProcessError& e2) {
225  if (string(e2.what()) != string("Process Error") && std::string(e2.what()) != string("")) {
226  WRITE_ERROR(e2.what());
227  }
228  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
230  mySimulationInProgress = false;
232  myEventQue.add(e);
234  myHalting = true;
235  myOk = false;
236 #ifndef _DEBUG
237  } catch (...) {
239  mySimulationInProgress = false;
241  myEventQue.add(e);
243  myHalting = true;
244  myOk = false;
245 #endif
246  }
247 }
248 
249 
250 void
252  mySingle = false;
253  myHalting = false;
254 }
255 
256 
257 void
259  mySingle = true;
260  myHalting = false;
261 }
262 
263 
264 void
266  // report the begin when wished
267  WRITE_MESSAGE("Simulation started with time: " + time2string(mySimStartTime));
268  myOk = true;
269 }
270 
271 
272 void
274  mySingle = false;
275  myHalting = true;
276 }
277 
278 
279 bool
281  return myNet != 0;
282 }
283 
284 
285 void
287  myHalting = true;
288  // remove message callbacks
292  //
294  if (myNet != 0) {
296  }
297  while (mySimulationInProgress);
298  delete myNet;
300  myNet = 0;
304 }
305 
306 
307 GUINet&
309  return *myNet;
310 }
311 
312 
313 void
315  myHalting = true;
316  myQuit = true;
317 }
318 
319 
320 void
321 GUIRunThread::retrieveMessage(const MsgHandler::MsgType type, const std::string& msg) {
322  GUIEvent* e = new GUIEvent_Message(type, msg);
323  myEventQue.add(e);
325 }
326 
327 
328 bool
330  return myNet != 0 && myHalting;
331 }
332 
333 
334 bool
336  return myNet != 0 && (!myHalting);
337 }
338 
339 
340 bool
342  return myNet != 0 && myHalting;
343 }
344 
345 
346 
347 /****************************************************************************/
348 
Event sent when the the simulation is over.
static MsgHandler * getWarningInstance()
Returns the instance to add warnings to.
Definition: MsgHandler.cpp:71
The message is only something to show.
Definition: MsgHandler.h:61
static MsgHandler * getErrorInstance()
Returns the instance to add errors to.
Definition: MsgHandler.cpp:80
virtual bool simulationIsStepable() const
virtual FXint run()
starts the execution
virtual void deleteSim()
virtual bool init(GUINet *net, SUMOTime start, SUMOTime end)
initialises the thread with the new simulation
The simulation contains too many vehicles (.
Definition: MSNet.h:104
virtual bool simulationIsStartable() const
std::string time2string(SUMOTime t)
Definition: SUMOTime.cpp:61
The final simulation step has been performed.
Definition: MSNet.h:96
void addRetriever(OutputDevice *retriever)
Adds a further retriever to the instance responsible for a certain msg type.
Definition: MsgHandler.cpp:161
SUMOTime getCurrentTimeStep() const
Returns the current simulation step (in s)
Definition: MSNet.cpp:500
void clear()
Clears this container.
SimulationState
Possible states of a simulation - running or stopped with different reasons.
Definition: MSNet.h:92
void setIdleDuration(int val)
Sets the duration of the last step&#39;s idle part.
Definition: GUINet.cpp:397
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:67
void add(void *what)
Definition: MFXEventQue.cpp:57
static std::vector< SUMOTime > gBreakpoints
List of breakpoints.
Definition: GUIGlobals.h:58
void retrieveMessage(const MsgHandler::MsgType type, const std::string &msg)
Retrieves messages from the loading module.
bool myHalting
information whether the simulation is halting (is not being executed)
Definition: GUIRunThread.h:121
The simulation does not contain further vehicles.
Definition: MSNet.h:98
An error occured during the simulation step.
Definition: MSNet.h:102
static bool wasClosed()
check whether close was requested
static void cleanupOnEnd()
Removes pending handler.
Definition: MsgHandler.cpp:238
MFXMutex mySimulationLock
Definition: GUIRunThread.h:147
FXdouble getValue() const
Return current value.
static void sleep(long ms)
virtual ~GUIRunThread()
destructor
static void closeAll()
void closeSimulation(SUMOTime start)
Closes the simulation (all files, connections, etc.)
Definition: MSNet.cpp:308
SUMOTime mySimEndTime
Definition: GUIRunThread.h:118
static GUIGlObjectStorage gIDStorage
A single static instance of this class.
The connection to a client was closed by the client.
Definition: MSNet.h:100
The simulation is running.
Definition: MSNet.h:94
void removeRetriever(OutputDevice *retriever)
Removes the retriever from the.
Definition: MsgHandler.cpp:177
bool mySimulationInProgress
Definition: GUIRunThread.h:130
static MsgHandler * getMessageInstance()
Returns the instance to add normal messages to.
Definition: MsgHandler.cpp:62
virtual bool simulationIsStopable() const
GUIRunThread(FXApp *app, MFXInterThreadEventClient *mw, FXRealSpinDial &simDelay, MFXEventQue &eq, FXEX::FXThreadEvent &ev)
constructor
OutputDevice * myWarningRetriever
Definition: GUIRunThread.h:139
GUINet * myNet
the loaded simulation network
Definition: GUIRunThread.h:115
GUINet & getNet() const
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:201
void unlock()
release mutex lock
Definition: MFXMutex.cpp:93
OutputDevice * myMessageRetriever
Definition: GUIRunThread.h:139
The message is a warning.
Definition: MsgHandler.h:63
void setSimDuration(int val)
Sets the duration of the last step&#39;s simulation part.
Definition: GUINet.cpp:381
Encapsulates an object&#39;s method for using it as a message retriever.
MFXEventQue & myEventQue
Definition: GUIRunThread.h:143
OutputDevice * myErrorRetriever
The instances of message retriever encapsulations Needed to be deleted from the handler later on...
Definition: GUIRunThread.h:139
SimulationState simulationState(SUMOTime stopTime) const
Called after a simulation step, this method returns the current simulation state. ...
Definition: MSNet.cpp:435
void prepareDestruction()
A MSNet extended by some values for usage within the gui.
Definition: GUINet.h:90
void inform(std::string msg, bool addType=true)
adds a new error to the list
Definition: MsgHandler.cpp:89
void lock()
lock mutex
Definition: MFXMutex.cpp:83
bool simulationAvailable() const
static std::string getStateMessage(SimulationState state)
Returns the message to show if a certain state occurs.
Definition: MSNet.cpp:466
void simulationStep()
Performs a single simulation step (locking the simulation)
Definition: GUINet.cpp:222
#define DELTA_T
Definition: SUMOTime.h:50
virtual void begin()
static long getCurrentMillis()
Returns the current time in milliseconds.
Definition: SysUtils.cpp:48
void loadRoutes()
loads routes for the next few steps
Definition: MSNet.cpp:302
FXEX::FXThreadEvent & myEventThrow
Definition: GUIRunThread.h:145
SUMOTime mySimStartTime
the times the simulation starts and ends with
Definition: GUIRunThread.h:118
Spinner control.
#define WRITE_MESSAGE(msg)
Definition: MsgHandler.h:197
void guiSimulationStep()
Some further steps needed for gui processing.
Definition: GUINet.cpp:215
FXRealSpinDial & mySimDelay
Definition: GUIRunThread.h:141
The message is an error.
Definition: MsgHandler.h:65