Eclipse SUMO - Simulation of Urban MObility
NIImporter_VISUM.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 // A VISUM network importer
17 /****************************************************************************/
18 #ifndef NIImporter_VISUM_h
19 #define NIImporter_VISUM_h
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 #include <string>
28 #include <map>
29 #include <vector>
34 #include "NIVisumTL.h"
35 
36 
37 // ===========================================================================
38 // class declaration
39 // ===========================================================================
40 class OptionsCont;
41 class NBNetBuilder;
42 class NBNodeCont;
43 class NBEdgeCont;
44 class NBNode;
45 class NBEdge;
46 
47 
48 // ===========================================================================
49 // class declaration
50 // ===========================================================================
70 public:
82  static void loadNetwork(const OptionsCont& oc, NBNetBuilder& nb);
83 
84 
85 protected:
96  NIImporter_VISUM(NBNetBuilder& nb, const std::string& file,
97  NBCapacity2Lanes capacity2Lanes, bool useVisumPrio,
98  const std::string& languageFile);
99 
100 
103 
104 
115  void load();
116 
117 private:
126  double getNamedFloat(const std::string& fieldName);
127 
137  double getNamedFloat(const std::string& fieldName1, const std::string& fieldName2);
138 
139 
146  double getNamedFloat(const std::string& fieldName, double defaultValue);
147 
155  double getNamedFloat(const std::string& fieldName1, const std::string& fieldName2,
156  double defaultValue);
157 
158 
169  std::string getNamedString(const std::string& fieldName);
170 
180  std::string getNamedString(const std::string& fieldName1, const std::string& fieldName2);
181 
182 
192  double getWeightedFloat(const std::string& name, const std::string& suffix);
193 
195  double getWeightedFloat2(const std::string& name, const std::string& name2, const std::string& suffix);
196 
198  SVCPermissions getPermissions(const std::string& name, bool warn = false, SVCPermissions unknown = SVCAll);
199 
209  bool getWeightedBool(const std::string& name);
210 
211 
224  NBNode* getNamedNode(const std::string& fieldName);
225  NBNode* getNamedNodeSecure(const std::string& fieldName, NBNode* fallback = 0);
226 
236  NBNode* getNamedNode(const std::string& fieldName1, const std::string& fieldName2);
237 
238 
251  NBEdge* getNamedEdge(const std::string& fieldName);
252 
262  NBEdge* getNamedEdge(const std::string& fieldName1, const std::string& fieldName2);
263 
264 
279  NBEdge* getNamedEdgeContinuating(const std::string& fieldName, NBNode* node);
280 
291  NBEdge* getNamedEdgeContinuating(const std::string& fieldName1, const std::string& fieldName2,
292  NBNode* node);
293 
301 
302 
309  NBEdge* getEdge(NBNode* FromNode, NBNode* ToNode);
310 
311 
323 
324 
337  NBNode* buildDistrictNode(const std::string& id, NBNode* dest, bool isSource);
338 
339 
348  bool checkNodes(NBNode* from, NBNode* to);
349 
350 
351 private:
358  typedef void (NIImporter_VISUM::*ParsingFunction)();
359 
364  struct TypeParser {
368  std::string name;
369 
373  ParsingFunction function;
374 
379  long position;
380 
384  std::string pattern;
385 
386  };
387 
388 
389 
391  void parse_VSysTypes();
392 
394  void parse_Types();
395 
397  void parse_Nodes();
398 
400  void parse_Districts();
401 
403  void parse_Point();
404 
405 
407  void parse_Edges();
408 
410  void parse_PartOfArea();
411 
413  void parse_Kante();
414 
415 
417  void parse_Connectors();
418 
420  void parse_Turns();
421 
423  void parse_EdgePolys();
424 
426  void parse_Lanes();
427 
429  void parse_TrafficLights();
430 
433 
435  void parse_SignalGroups();
436 
439 
442 
444  void parse_Phases();
445 
448 
450  void parse_LanesConnections();
451 
452 
458  void addParser(const std::string& name, ParsingFunction function);
459 
460 private:
461 
463  static bool isSplitEdge(NBEdge* edge, NBNode* node);
464 
465 
466 private:
469 
471  std::string myFileName;
472 
475 
480 
483 
485  typedef std::map<std::string, std::string> VSysTypeNames;
487  VSysTypeNames myVSysTypes;
488 
490  typedef std::vector<TypeParser> ParserVector;
492  ParserVector mySingleDataParsers;
493 
495  typedef std::map<std::string, NIVisumTL*> NIVisumTL_Map;
497  NIVisumTL_Map myTLS;
498 
500  std::vector<std::string > myTouchedEdges;
501 
504 
506  std::string myCurrentID;
507 
508 
510  std::map<long long int, Position> myPoints;
511 
513  std::map<long long int, std::pair<long long int, long long int> > myEdges;
514 
516  std::map<long long int, NBDistrict*> myShapeDistrictMap;
517 
519  std::map<long long int, std::vector<long long int> > mySubPartsAreas;
520 
522  std::map<NBDistrict*, PositionVector> myDistrictShapes;
523 
524 protected:
529  enum VISUM_KEY {
545  VISUM_NO // must be the last one
546  };
547 
550 
553 
554  void loadLanguage(const std::string& file);
555 };
556 
557 
558 #endif
559 
560 /****************************************************************************/
561 
long position
Position of the according db within the file.
void parse_NodesToTrafficLights()
Parses KNOTENZULSA/SIGNALANLAGEZUKNOTEN.
std::vector< TypeParser > ParserVector
Definition of the list of known parsers.
void parse_Kante()
Parses FLAECHENELEMENT.
bool myUseVisumPrio
Information whether VISUM priority information shall be used.
void load()
Parses the VISUM-network file storing the parsed structures within myNetBuilder.
std::map< NBDistrict *, PositionVector > myDistrictShapes
A temporary storage for district shapes as they are filled incrementally.
LineReader myLineReader
The line reader to use to read from the file.
std::vector< std::string > myTouchedEdges
Already read edges.
NBEdge * getNamedEdgeContinuating(const std::string &fieldName, NBNode *node)
Tries to get the edge which name is stored in the given field continuating the search for a subedge t...
static bool isSplitEdge(NBEdge *edge, NBNode *node)
whether the edge id ends with _nodeID
std::string myCurrentID
The name of the currently parsed item used for error reporting.
void parse_Turns()
Parses ABBIEGEBEZIEHUNG/ABBIEGER.
NIImporter_VISUM(NBNetBuilder &nb, const std::string &file, NBCapacity2Lanes capacity2Lanes, bool useVisumPrio, const std::string &languageFile)
constructor
Retrieves a file linewise and reports the lines to a handler.
Definition: LineReader.h:51
VSysTypeNames myVSysTypes
The used vsystypes.
NBNode * getNamedNode(const std::string &fieldName)
Tries to get the node which name is stored in the given field.
void parse_TrafficLights()
Parses LSA/SIGNALANLAGE.
void loadLanguage(const std::string &file)
A helper class which computes the lane number from given capacity.
int SVCPermissions
bitset where each bit declares whether a certain SVC may use this edge/lane
The representation of a single edge during network building.
Definition: NBEdge.h:86
void parse_PartOfArea()
Parses FLAECHENELEMENT.
void parse_SignalGroupsToPhases()
Parses LSASIGNALGRUPPEZULSAPHASE.
void parse_EdgePolys()
Parses STRECKENPOLY.
void parse_Phases()
Parses LSAPHASE/PHASE.
std::string myFileName
The name of the parsed file, for error reporting.
const SVCPermissions SVCAll
all VClasses are allowed
void parse_AreaSubPartElement()
Parses ABBZULSASIGNALGRUPPE/SIGNALGRUPPEZUABBIEGER.
std::map< std::string, std::string > VSysTypeNames
Definition of a storage for vsystypes.
NBEdge * getReversedContinuating(NBEdge *edge, NBNode *node)
Returns the opposite direction of the given edge.
void parse_SignalGroups()
Parses LSASIGNALGRUPPE/SIGNALGRUPPE.
static void loadNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Loads network definition from the assigned option and stores it in the given network builder...
A VISUM network importer.
void parse_TurnsToSignalGroups()
Parses ABBZULSASIGNALGRUPPE/SIGNALGRUPPEZUABBIEGER.
std::string pattern
The column names.
std::string getNamedString(const std::string &fieldName)
Returns the value from the named column as a normalised string.
static StringBijection< VISUM_KEY >::Entry KEYS_DE[]
Strings for the keywords.
double getNamedFloat(const std::string &fieldName)
Returns the value from the named column as a float.
std::map< long long int, std::pair< long long int, long long int > > myEdges
A map of edge (not road, but "edge" in this case) ids to from/to-points.
A complete call description for parsing a single db.
NIVisumTL_Map myTLS
List of visum traffic lights.
void parse_Connectors()
Parses ANBINDUNG.
double getWeightedFloat2(const std::string &name, const std::string &name2, const std::string &suffix)
as above but with two alternative names
std::map< long long int, std::vector< long long int > > mySubPartsAreas
A map from area parts to area ids.
Storage for edges, including some functionality operating on multiple edges.
Definition: NBEdgeCont.h:61
double getWeightedFloat(const std::string &name, const std::string &suffix)
tries to get a double which is possibly assigned to a certain modality
void parse_Districts()
Parses BEZIRK.
void addParser(const std::string &name, ParsingFunction function)
Adds a parser into the sorted list of parsers to use.
ParserVector mySingleDataParsers
List of known parsers.
std::map< long long int, Position > myPoints
A map of point ids to positions.
void parse_Point()
Parses PUNKT.
void(NIImporter_VISUM::* ParsingFunction)()
Definition of a function for parsing a single line from a certain db.
NBEdge * getEdge(NBNode *FromNode, NBNode *ToNode)
Returns the edge that connects both nodes.
std::map< std::string, NIVisumTL * > NIVisumTL_Map
Definition of a map for loaded traffic lights (id->tls)
void parse_VSysTypes()
Parses VSYS.
SVCPermissions getPermissions(const std::string &name, bool warn=false, SVCPermissions unknown=SVCAll)
parse permissions
void parse_Types()
Parses STRECKENTYP.
void parse_Nodes()
Parses KNOTEN.
void parse_Lanes()
Parses FAHRSTREIFEN.
~NIImporter_VISUM()
destructor
Instance responsible for building networks.
Definition: NBNetBuilder.h:110
NamedColumnsParser myLineParser
the parser to parse the information from the data lines
std::map< long long int, NBDistrict * > myShapeDistrictMap
A map from district shape definition name to the district.
A storage for options typed value containers)
Definition: OptionsCont.h:90
std::string name
The name of the db.
NBNode * buildDistrictNode(const std::string &id, NBNode *dest, bool isSource)
Builds a node for the given district and returns it.
Represents a single node (junction) during network building.
Definition: NBNode.h:68
bool getWeightedBool(const std::string &name)
tries to get a bool which is possibly assigned to a certain modality
A parser to retrieve information from a table with known columns.
void parse_Edges()
Parses STRECKE/STRECKEN.
NBNetBuilder & myNetBuilder
The network builder to fill with loaded values.
Container for nodes during the netbuilding process.
Definition: NBNodeCont.h:60
bool checkNodes(NBNode *from, NBNode *to)
Returns whether both nodes are a valid combination of from/to-nodes.
NBEdge * getNamedEdge(const std::string &fieldName)
Tries to get the edge which name is stored in the given field.
static StringBijection< VISUM_KEY > KEYS
link directions
NBCapacity2Lanes myCapacity2Lanes
The converter to compute the lane number of edges from their capacity.
void parse_LanesConnections()
Parses FAHRSTREIFENABBIEGER.
NBNode * getNamedNodeSecure(const std::string &fieldName, NBNode *fallback=0)