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>
30
31
32// ===========================================================================
33// class declarations
34// ===========================================================================
35class MSTrigger;
36class MSNet;
38class NLHandler;
40class MSLane;
41class MSEdge;
42class MSStoppingPlace;
43class MSCalibrator;
44class MSRouteProbe;
45
47
48
49// ===========================================================================
50// class definitions
51// ===========================================================================
61public:
64
65
67 virtual ~NLTriggerBuilder();
68
69
74 void setHandler(NLHandler* handler);
75
76
86 void buildVaporizer(const SUMOSAXAttributes& attrs);
87
88
93
94
110 const std::string& base);
111
112
119 void parseAndBuildRerouter(MSNet& net, const SUMOSAXAttributes& attrs);
120
121
129 void parseAndBuildStoppingPlace(MSNet& net, const SUMOSAXAttributes& attrs, const SumoXMLTag element);
130
131
148 virtual void beginParkingArea(MSNet& net,
149 const std::string& id, const std::vector<std::string>& lines,
150 MSLane* lane, double frompos, double topos,
151 unsigned int capacity,
152 double width, double length, double angle, const std::string& name,
153 bool onRoad,
154 const std::string& departPos);
155
156
170 void addLotEntry(double x, double y, double z,
171 double width, double length,
172 double angle, double slope);
173
174
175
182 void addAccess(MSNet& net, const SUMOSAXAttributes& attrs);
183
184
191 void parseAndBeginParkingArea(MSNet& net, const SUMOSAXAttributes& attrs);
192
193
198 void parseAndAddLotEntry(const SUMOSAXAttributes& attrs);
199
200
205 virtual void endParkingArea();
206
211 virtual void endStoppingPlace();
212
213
221
229
237
245
255
263 void parseAndBuildCalibrator(MSNet& net, const SUMOSAXAttributes& attrs,
264 const std::string& base);
266
267
269
270
271protected:
280
281
294 const std::string& id, const std::vector<MSLane*>& destLanes,
295 const std::string& file);
296
297
311 virtual void buildStoppingPlace(MSNet& net, std::string id, std::vector<std::string> lines, MSLane* lane,
312 double frompos, double topos, const SumoXMLTag element, std::string string,
313 int personCapacity, double parkingLength, RGBColor& color);
314
330 virtual void buildChargingStation(MSNet& net, const std::string& id, MSLane* lane, double frompos, double topos, const std::string& name,
331 double chargingPower, double efficiency, bool chargeInTransit, SUMOTime chargeDelay);
332
345 virtual void buildOverheadWireSegment(MSNet& net, const std::string& id, MSLane* lane, double frompos, double topos, bool voltageSource);
346
358 void buildInnerOverheadWireSegments(MSNet& net, const MSLane* connection, const MSLane* frontConnection, const MSLane* behindConnection);
359
370 void buildTractionSubstation(MSNet& net, std::string id, double voltage, double currentLimit);
371
372 virtual void buildOverheadWireClamp(MSNet& net, const std::string& id, MSLane* lane_start, MSLane* lane_end);
373
385 virtual MSCalibrator* buildCalibrator(MSNet& net,
386 const std::string& id, MSEdge* edge, MSLane* lane, double pos,
387 const std::string& file, const std::string& outfile,
388 const SUMOTime freq,
389 const MSRouteProbe* probe,
390 const double invalidJamThreshold,
391 const std::string& vTypes);
392
405 const std::string& id, const MSEdge* edge, double pos,
406 const std::string& file, const std::string& outfile,
407 const SUMOTime freq,
408 MSRouteProbe* probe,
409 const double invalidJamThreshold,
410 const std::string& vTypes);
411
412
423 const std::string& id, MSEdgeVector& edges,
424 double prob, bool off, SUMOTime timeThreshold,
425 const std::string& vTypes);
427
428
429protected:
432
444 std::string getFileName(const SUMOSAXAttributes& attrs,
445 const std::string& base,
446 const bool allowEmpty = false);
447
448
460 MSLane* getLane(const SUMOSAXAttributes& attrs,
461 const std::string& tt, const std::string& tid);
462
463
477 double getPosition(const SUMOSAXAttributes& attrs,
478 MSLane* lane, const std::string& tt, const std::string& tid, MSEdge* edge = 0);
480
481
482protected:
489
491};
long long int SUMOTime
Definition: GUI.h:36
std::vector< MSEdge * > MSEdgeVector
Definition: MSEdge.h:73
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:47
A road/street connecting two junctions.
Definition: MSEdge.h:77
Representation of a lane in the micro simulation.
Definition: MSLane.h:84
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.
Reroutes vehicles passing an edge.
The XML-Handler for network loading.
Definition: NLHandler.h:79
Builds trigger objects for microsim.
virtual MSTriggeredRerouter * buildRerouter(MSNet &net, const std::string &id, MSEdgeVector &edges, double prob, bool off, SUMOTime timeThreshold, const std::string &vTypes)
builds an rerouter
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.
void parseAndBuildRerouter(MSNet &net, const SUMOSAXAttributes &attrs)
Parses his values and builds a 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.
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.