SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GUILoadThread.cpp
Go to the documentation of this file.
1 /****************************************************************************/
9 // Class describing the thread that performs the loading of a simulation
10 /****************************************************************************/
11 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
12 // Copyright (C) 2001-2014 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 <iostream>
34 #include <ctime>
40 #include <utils/options/Option.h>
47 #include <utils/xml/XMLSubSys.h>
48 #include <guisim/GUINet.h>
49 #include <guisim/GUIEventControl.h>
51 #include <netload/NLBuilder.h>
52 #include <netload/NLHandler.h>
58 #include <microsim/MSFrame.h>
59 #include "GUIApplicationWindow.h"
60 #include "GUILoadThread.h"
61 #include "GUIGlobals.h"
63 
64 #ifdef HAVE_INTERNAL
65 #include <mesogui/GUIMEVehicleControl.h>
66 #endif
67 
68 #ifndef NO_TRACI
70 #include "TraCIServerAPI_GUI.h"
71 #endif
72 
73 #ifdef CHECK_MEMORY_LEAKS
74 #include <foreign/nvwa/debug_new.h>
75 #endif // CHECK_MEMORY_LEAKS
76 
77 
78 // ===========================================================================
79 // member method definitions
80 // ===========================================================================
83  : FXSingleEventThread(app, mw), myParent(mw), myEventQue(eq),
84  myEventThrow(ev) {
89 }
90 
91 
93  delete myErrorRetriever;
94  delete myMessageRetriever;
95  delete myWarningRetriever;
96 }
97 
98 
99 FXint
101  GUINet* net = 0;
102  int simStartTime = 0;
103  int simEndTime = 0;
104  std::vector<std::string> guiSettingsFiles;
105  bool osgView = false;
107 
108  // register message callbacks
111  if (!OptionsCont::getOptions().getBool("no-warnings")) {
113  }
114 
115  // try to load the given configuration
116  if (!initOptions()) {
117  // the options are not valid but maybe we want to quit
118  GUIGlobals::gQuitOnEnd = oc.getBool("quit-on-end");
119  submitEndAndCleanup(net, simStartTime, simEndTime);
120  return 0;
121  }
122  // within gui-based applications, nothing is reported to the console
126  // do this once again to get parsed options
128  XMLSubSys::setValidation(oc.getString("xml-validation"), oc.getString("xml-validation.net"));
129  GUIGlobals::gRunAfterLoad = oc.getBool("start");
130  GUIGlobals::gQuitOnEnd = oc.getBool("quit-on-end");
131 
132  if (!MSFrame::checkOptions()) {
133  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
134  submitEndAndCleanup(net, simStartTime, simEndTime);
135  return 0;
136  }
137 
138  // initialise global settings
142  GUITexturesHelper::allowTextures(!oc.getBool("disable-textures"));
143  MSVehicleControl* vehControl = 0;
144 #ifdef HAVE_INTERNAL
145  GUIVisualizationSettings::UseMesoSim = MSGlobals::gUseMesoSim;
147  vehControl = new GUIMEVehicleControl();
148  } else
149 #endif
150  vehControl = new GUIVehicleControl();
151 
152  GUIEdgeControlBuilder* eb = 0;
153  try {
154  net = new GUINet(
155  vehControl,
156  new GUIEventControl(),
157  new GUIEventControl(),
158  new GUIEventControl());
159 #ifndef NO_TRACI
160  // need to init TraCI-Server before loading routes to catch VEHICLE_STATE_BUILT
161  std::map<int, TraCIServer::CmdExecutor> execs;
165 #endif
166 
167  eb = new GUIEdgeControlBuilder();
168  GUIDetectorBuilder db(*net);
169  NLJunctionControlBuilder jb(*net, db);
171  NLHandler handler("", *net, db, tb, *eb, jb);
172  tb.setHandler(&handler);
173  NLBuilder builder(oc, *net, *eb, jb, db, handler);
177  if (!builder.build()) {
178  throw ProcessError();
179  } else {
180  net->initGUIStructures();
181  simStartTime = string2time(oc.getString("begin"));
182  simEndTime = string2time(oc.getString("end"));
183  guiSettingsFiles = oc.getStringVector("gui-settings-file");
184 #ifdef HAVE_INTERNAL
185  osgView = oc.getBool("osg-view");
186 #endif
187  }
188  } catch (ProcessError& e) {
189  if (std::string(e.what()) != std::string("Process Error") && std::string(e.what()) != std::string("")) {
190  WRITE_ERROR(e.what());
191  }
192  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
193  delete net;
194  net = 0;
195 #ifndef _DEBUG
196  } catch (std::exception& e) {
197  WRITE_ERROR(e.what());
198  delete net;
199  net = 0;
200 #endif
201  }
202  if (net == 0) {
203  MSNet::clearAll();
204  }
205  delete eb;
206  submitEndAndCleanup(net, simStartTime, simEndTime, guiSettingsFiles, osgView);
207  return 0;
208 }
209 
210 
211 
212 void
214  const SUMOTime simStartTime,
215  const SUMOTime simEndTime,
216  const std::vector<std::string>& guiSettingsFiles,
217  const bool osgView) {
218  // remove message callbacks
222  // inform parent about the process
223  GUIEvent* e = new GUIEvent_SimulationLoaded(net, simStartTime, simEndTime, myFile, guiSettingsFiles, osgView);
224  myEventQue.add(e);
226 }
227 
228 
229 bool
231  try {
233  oc.clear();
235  if (myFile != "") {
236  if (myLoadNet) {
237  oc.set("net-file", myFile);
238  } else {
239  oc.set("configuration-file", myFile);
240  }
241  OptionsIO::getOptions(true, 1, 0);
242  } else {
243  OptionsIO::getOptions(true);
244  }
245  return true;
246  } catch (ProcessError& e) {
247  if (std::string(e.what()) != std::string("Process Error") && std::string(e.what()) != std::string("")) {
248  WRITE_ERROR(e.what());
249  }
250  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
251  }
252  return false;
253 }
254 
255 
256 void
257 GUILoadThread::load(const std::string& file, bool isNet) {
258  myFile = file;
259  myLoadNet = isNet;
260  start();
261 }
262 
263 
264 void
265 GUILoadThread::retrieveMessage(const MsgHandler::MsgType type, const std::string& msg) {
266  GUIEvent* e = new GUIEvent_Message(type, msg);
267  myEventQue.add(e);
269 }
270 
271 
272 const std::string&
274  return myFile;
275 }
276 
277 
278 
279 /****************************************************************************/
280 
void setHandler(NLHandler *handler)
Sets the parent handler to use for nested parsing.
static MsgHandler * getWarningInstance()
Returns the instance to add warnings to.
Definition: MsgHandler.cpp:71
The message is only something to show.
Definition: MsgHandler.h:62
std::vector< std::string > getStringVector(const std::string &name) const
Returns the list of string-vector-value of the named option (only for Option_String) ...
static MsgHandler * getErrorInstance()
Returns the instance to add errors to.
Definition: MsgHandler.cpp:80
The class responsible for building and deletion of vehicles (gui-version)
OutputDevice * myWarningRetriever
Definition: GUILoadThread.h:99
static void getOptions(bool loadConfig, int argc=0, char **argv=0)
Parses the command line arguments and loads the configuration optionally.
Definition: OptionsIO.cpp:64
The main interface for loading a microsim.
Definition: NLBuilder.h:68
static void setValidation(const std::string &validationScheme, const std::string &netValidationScheme)
Enables or disables validation.
Definition: XMLSubSys.cpp:69
void load(const std::string &file, bool isNet)
begins the loading of the given file
GUILoadThread(FXApp *app, MFXInterThreadEventClient *mw, MFXEventQue &eq, FXEX::FXThreadEvent &ev)
constructor
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
static bool gRunAfterLoad
the simulation shall start direct after loading
Definition: GUIGlobals.h:52
FXEX::FXThreadEvent & myEventThrow
void initGUIStructures()
Initialises gui wrappers.
Definition: GUINet.cpp:257
void addRetriever(OutputDevice *retriever)
Adds a further retriever to the instance responsible for a certain msg type.
Definition: MsgHandler.cpp:161
void submitEndAndCleanup(GUINet *net, const SUMOTime simStartTime, const SUMOTime simEndTime, const std::vector< std::string > &guiSettingsFiles=std::vector< std::string >(), const bool osgView=false)
Closes the loading process.
Derivation of NLEdgeControlBuilder which builds gui-edges.
Builds detectors for guisim.
OutputDevice * myErrorRetriever
The instances of message retriever encapsulations Needed to be deleted from the handler later on...
Definition: GUILoadThread.h:99
#define CMD_SET_GUI_VARIABLE
static bool processSet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a set value command (Command 0xcc: Change GUI State)
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:67
void add(void *what)
Definition: MFXEventQue.cpp:57
static void initRandGlobal(MTRand *which=0)
Reads the given random number options and initialises the random number generator in accordance...
Definition: RandHelper.cpp:68
OutputDevice * myMessageRetriever
Definition: GUILoadThread.h:99
static void fillOptions()
Inserts options used by the simulation into the OptionsCont-singleton.
Definition: MSFrame.cpp:70
Builds trigger objects for guisim.
virtual ~GUILoadThread()
destructor
virtual bool initOptions()
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
void clear()
Removes all information from the container.
Builder of microsim-junctions and tls.
SUMOTime string2time(const std::string &r)
Definition: SUMOTime.cpp:48
void removeRetriever(OutputDevice *retriever)
Removes the retriever from the handler.
Definition: MsgHandler.cpp:175
static MsgHandler * getMessageInstance()
Returns the instance to add normal messages to.
Definition: MsgHandler.cpp:62
#define CMD_GET_GUI_VARIABLE
const std::string & getFileName() const
static MTRand myVehicleParamsRNG
A random number generator used to choose from vtype/route distributions and computing the speed facto...
bool myLoadNet
Information whether only the network shall be loaded.
The XML-Handler for network loading.
Definition: NLHandler.h:72
static bool gQuitOnEnd
the window shall be closed when the simulation has ended
Definition: GUIGlobals.h:55
static bool checkOptions()
Checks the set options.
Definition: MSFrame.cpp:377
virtual bool build()
Builds and initialises the simulation.
Definition: NLBuilder.cpp:122
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:205
void retrieveMessage(const MsgHandler::MsgType type, const std::string &msg)
Retrieves messages from the loading module.
The message is a warning.
Definition: MsgHandler.h:64
Encapsulates an object's method for using it as a message retriever.
static void clearAll()
Clears all dictionaries.
Definition: MSNet.cpp:513
static void openSocket(const std::map< int, CmdExecutor > &execs)
Initialises the server.
bool set(const std::string &name, const std::string &value)
Sets the given value for the named option.
A MSNet extended by some values for usage within the gui.
Definition: GUINet.h:90
static OutputDevice & getDevice(const std::string &name)
Returns the described OutputDevice.
void inform(std::string msg, bool addType=true)
adds a new error to the list
Definition: MsgHandler.cpp:89
A storage for options typed value containers)
Definition: OptionsCont.h:108
Stores time-dependant events and executes them at the proper time (guisim)
static const bool gUseMesoSim
Definition: MSGlobals.h:99
static void setMSGlobals(OptionsCont &oc)
Sets the global microsim-options.
Definition: MSFrame.cpp:436
std::string myFile
the path to load the simulation from
Definition: GUILoadThread.h:95
static void allowTextures(const bool val)
don't draw any textures
The class responsible for building and deletion of vehicles.
void clear()
Clears information whether an error occured previously.
Definition: MsgHandler.cpp:149
MFXEventQue & myEventQue
static void initOutputOptions()
Definition: MsgHandler.cpp:197
static bool processGet(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xac: Get GUI Variable)
The message is an error.
Definition: MsgHandler.h:66