Eclipse SUMO - Simulation of Urban MObility
NLTriggerBuilder.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2002-2022 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials are made available under the
5 // terms of the Eclipse Public License 2.0 which is available at
6 // https://www.eclipse.org/legal/epl-2.0/
7 // This Source Code may also be made available under the following Secondary
8 // Licenses when the conditions for such availability set forth in the Eclipse
9 // Public License 2.0 are satisfied: GNU General Public License, version 2
10 // or later which is available at
11 // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13 /****************************************************************************/
22 // Builds trigger objects for microsim
23 /****************************************************************************/
24 #pragma once
25 #include <config.h>
26 
27 #include <string>
28 #include <vector>
29 #include <utils/common/RGBColor.h>
30 
31 
32 // ===========================================================================
33 // class declarations
34 // ===========================================================================
35 class MSTrigger;
36 class MSNet;
37 class MSLaneSpeedTrigger;
38 class NLHandler;
40 class MSLane;
41 class MSEdge;
42 class MSStoppingPlace;
43 class MSCalibrator;
44 class MSRouteProbe;
45 
47 
48 
49 // ===========================================================================
50 // class definitions
51 // ===========================================================================
61 public:
64 
65 
67  virtual ~NLTriggerBuilder();
68 
69 
74  void setHandler(NLHandler* handler);
75 
76 
86  void buildVaporizer(const SUMOSAXAttributes& attrs);
87 
88 
93 
94 
109  void parseAndBuildLaneSpeedTrigger(MSNet& net, const SUMOSAXAttributes& attrs,
110  const std::string& base);
111 
112 
120  void parseAndBuildRerouter(MSNet& net, const SUMOSAXAttributes& attrs,
121  const std::string& base);
122 
123 
131  void parseAndBuildStoppingPlace(MSNet& net, const SUMOSAXAttributes& attrs, const SumoXMLTag element);
132 
133 
150  virtual void beginParkingArea(MSNet& net,
151  const std::string& id, const std::vector<std::string>& lines,
152  MSLane* lane, double frompos, double topos,
153  unsigned int capacity,
154  double width, double length, double angle, const std::string& name,
155  bool onRoad,
156  const std::string& departPos);
157 
158 
172  void addLotEntry(double x, double y, double z,
173  double width, double length,
174  double angle, double slope);
175 
176 
177 
184  void addAccess(MSNet& net, const SUMOSAXAttributes& attrs);
185 
186 
193  void parseAndBeginParkingArea(MSNet& net, const SUMOSAXAttributes& attrs);
194 
195 
200  void parseAndAddLotEntry(const SUMOSAXAttributes& attrs);
201 
202 
207  virtual void endParkingArea();
208 
213  virtual void endStoppingPlace();
214 
215 
222  void parseAndBuildChargingStation(MSNet& net, const SUMOSAXAttributes& attrs);
223 
231 
239 
247 
256  void parseAndBuildOverheadWireClamp(MSNet& net, const SUMOSAXAttributes& attrs);
257 
265  void parseAndBuildCalibrator(MSNet& net, const SUMOSAXAttributes& attrs,
266  const std::string& base);
268 
269 
271 
272 
273 protected:
282 
283 
296  const std::string& id, const std::vector<MSLane*>& destLanes,
297  const std::string& file);
298 
299 
313  virtual void buildStoppingPlace(MSNet& net, std::string id, std::vector<std::string> lines, MSLane* lane,
314  double frompos, double topos, const SumoXMLTag element, std::string string,
315  int personCapacity, double parkingLength, RGBColor& color);
316 
332  virtual void buildChargingStation(MSNet& net, const std::string& id, MSLane* lane, double frompos, double topos, const std::string& name,
333  double chargingPower, double efficiency, bool chargeInTransit, SUMOTime chargeDelay);
334 
347  virtual void buildOverheadWireSegment(MSNet& net, const std::string& id, MSLane* lane, double frompos, double topos, bool voltageSource);
348 
360  void buildInnerOverheadWireSegments(MSNet& net, const MSLane* connection, const MSLane* frontConnection, const MSLane* behindConnection);
361 
372  void buildTractionSubstation(MSNet& net, std::string id, double voltage, double currentLimit);
373 
374  virtual void buildOverheadWireClamp(MSNet& net, const std::string& id, MSLane* lane_start, MSLane* lane_end);
375 
387  virtual MSCalibrator* buildCalibrator(MSNet& net,
388  const std::string& id, MSEdge* edge, MSLane* lane, double pos,
389  const std::string& file, const std::string& outfile,
390  const SUMOTime freq,
391  const MSRouteProbe* probe,
392  const double invalidJamThreshold,
393  const std::string& vTypes);
394 
407  const std::string& id, const MSEdge* edge, double pos,
408  const std::string& file, const std::string& outfile,
409  const SUMOTime freq,
410  MSRouteProbe* probe,
411  const double invalidJamThreshold,
412  const std::string& vTypes);
413 
414 
426  const std::string& id, MSEdgeVector& edges,
427  double prob, const std::string& file, bool off,
428  SUMOTime timeThreshold,
429  const std::string& vTypes);
431 
432 
433 protected:
436 
448  std::string getFileName(const SUMOSAXAttributes& attrs,
449  const std::string& base,
450  const bool allowEmpty = false);
451 
452 
464  MSLane* getLane(const SUMOSAXAttributes& attrs,
465  const std::string& tt, const std::string& tid);
466 
467 
481  double getPosition(const SUMOSAXAttributes& attrs,
482  MSLane* lane, const std::string& tt, const std::string& tid, MSEdge* edge = 0);
484 
485 
486 protected:
493 
495 };
std::vector< MSEdge * > MSEdgeVector
Definition: MSEdge.h:73
long long int SUMOTime
Definition: SUMOTime.h:32
SumoXMLTag
Numbers representing SUMO-XML - element names.
Calibrates the flow on a segment to a specified one.
Calibrates the flow on a segment to a specified one.
Definition: MSCalibrator.h:48
A road/street connecting two junctions.
Definition: MSEdge.h:77
Representation of a lane in the micro simulation.
Definition: MSLane.h:82
Changes the speed allowed on a set of lanes.
The simulated network and simulation perfomer.
Definition: MSNet.h:88
A lane area vehicles can halt at.
Definition: MSParkingArea.h:58
Writes routes of vehicles passing a certain edge.
Definition: MSRouteProbe.h:58
A lane area vehicles can halt at.
An abstract device that changes the state of the micro simulation.
Definition: MSTrigger.h:38
Reroutes vehicles passing an edge.
The XML-Handler for network loading.
Definition: NLHandler.h:79
Builds trigger objects for microsim.
NLTriggerBuilder()
Constructor.
virtual void buildOverheadWireClamp(MSNet &net, const std::string &id, MSLane *lane_start, MSLane *lane_end)
MSParkingArea * myParkingArea
definition of the currently parsed parking area
void parseAndBuildTractionSubstation(MSNet &net, const SUMOSAXAttributes &attrs)
Parses its values and builds a traction substation.
virtual void beginParkingArea(MSNet &net, const std::string &id, const std::vector< std::string > &lines, MSLane *lane, double frompos, double topos, unsigned int capacity, double width, double length, double angle, const std::string &name, bool onRoad, const std::string &departPos)
Begin a parking area.
void addAccess(MSNet &net, const SUMOSAXAttributes &attrs)
Parses the values and adds an access point to the currently parsed stopping place.
void parseAndBuildOverheadWireSegment(MSNet &net, const SUMOSAXAttributes &attrs)
Parses its values and builds an overhead wire segment.
void parseAndBuildCalibrator(MSNet &net, const SUMOSAXAttributes &attrs, const std::string &base)
Parses his values and builds a mesoscopic or microscopic calibrator.
double getPosition(const SUMOSAXAttributes &attrs, MSLane *lane, const std::string &tt, const std::string &tid, MSEdge *edge=0)
returns the position on the lane checking it
void buildInnerOverheadWireSegments(MSNet &net, const MSLane *connection, const MSLane *frontConnection, const MSLane *behindConnection)
Builds an overhead wire inner segments.
virtual MSLaneSpeedTrigger * buildLaneSpeedTrigger(MSNet &net, const std::string &id, const std::vector< MSLane * > &destLanes, const std::string &file)
Builds a lane speed trigger.
virtual void endParkingArea()
End a parking area.
void parseAndBuildLaneSpeedTrigger(MSNet &net, const SUMOSAXAttributes &attrs, const std::string &base)
Parses his values and builds a lane speed trigger.
void parseAndAddLotEntry(const SUMOSAXAttributes &attrs)
Parses his values and adds a lot entry to current parking area.
NLHandler * myHandler
The parent handler to set for subhandlers.
MSLane * getLane(const SUMOSAXAttributes &attrs, const std::string &tt, const std::string &tid)
Returns the lane defined by attribute "lane".
void buildVaporizer(const SUMOSAXAttributes &attrs)
Builds a vaporization.
virtual MSTriggeredRerouter * buildRerouter(MSNet &net, const std::string &id, MSEdgeVector &edges, double prob, const std::string &file, bool off, SUMOTime timeThreshold, const std::string &vTypes)
builds an rerouter
void parseAndBuildOverheadWireSection(MSNet &net, const SUMOSAXAttributes &attrs)
Parses its values and builds an overhead wire section.
void setHandler(NLHandler *handler)
Sets the parent handler to use for nested parsing.
virtual MSCalibrator * buildCalibrator(MSNet &net, const std::string &id, MSEdge *edge, MSLane *lane, double pos, const std::string &file, const std::string &outfile, const SUMOTime freq, const MSRouteProbe *probe, const double invalidJamThreshold, const std::string &vTypes)
builds a microscopic calibrator
virtual ~NLTriggerBuilder()
Destructor.
void buildTractionSubstation(MSNet &net, std::string id, double voltage, double currentLimit)
Builds a traction substation.
void addLotEntry(double x, double y, double z, double width, double length, double angle, double slope)
Add a lot entry to current parking area.
void parseAndBuildChargingStation(MSNet &net, const SUMOSAXAttributes &attrs)
Parses his values and builds a charging station.
void parseAndBuildOverheadWireClamp(MSNet &net, const SUMOSAXAttributes &attrs)
Parses its values and builds an overhead wire clamp.
void parseAndBuildRerouter(MSNet &net, const SUMOSAXAttributes &attrs, const std::string &base)
Parses his values and builds a rerouter.
virtual void endStoppingPlace()
End a stopping place.
virtual void buildOverheadWireSegment(MSNet &net, const std::string &id, MSLane *lane, double frompos, double topos, bool voltageSource)
Builds an overhead wire segment.
MSStoppingPlace * myCurrentStop
The currently parsed stop to add access points to.
MSStoppingPlace * getCurrentStop()
virtual METriggeredCalibrator * buildMECalibrator(MSNet &net, const std::string &id, const MSEdge *edge, double pos, const std::string &file, const std::string &outfile, const SUMOTime freq, MSRouteProbe *probe, const double invalidJamThreshold, const std::string &vTypes)
builds a mesoscopic calibrator
virtual void buildStoppingPlace(MSNet &net, std::string id, std::vector< std::string > lines, MSLane *lane, double frompos, double topos, const SumoXMLTag element, std::string string, int personCapacity, double parkingLength, RGBColor &color)
Builds a stopping place.
virtual void buildChargingStation(MSNet &net, const std::string &id, MSLane *lane, double frompos, double topos, const std::string &name, double chargingPower, double efficiency, bool chargeInTransit, SUMOTime chargeDelay)
Builds a charging station.
void parseAndBuildStoppingPlace(MSNet &net, const SUMOSAXAttributes &attrs, const SumoXMLTag element)
Parses the values and builds a stopping places for busses, trains or container vehicles.
void parseAndBeginParkingArea(MSNet &net, const SUMOSAXAttributes &attrs)
Parses his values and builds a parking area.
std::string getFileName(const SUMOSAXAttributes &attrs, const std::string &base, const bool allowEmpty=false)
Helper method to obtain the filename.
Encapsulated SAX-Attributes.