SUMO - Simulation of Urban MObility
SUMOVehicleParameter.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-2018 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 /****************************************************************************/
18 // Structure representing possible vehicle parameter
19 /****************************************************************************/
20 #ifndef SUMOVehicleParameter_h
21 #define SUMOVehicleParameter_h
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 #include <config.h>
28 
29 #include <string>
31 #include <utils/common/RGBColor.h>
32 #include <utils/common/SUMOTime.h>
34 
35 
36 // ===========================================================================
37 // class declarations
38 // ===========================================================================
39 class OutputDevice;
40 class OptionsCont;
41 
42 
43 // ===========================================================================
44 // value definitions
45 // ===========================================================================
46 const int VEHPARS_COLOR_SET = 1;
47 const int VEHPARS_VTYPE_SET = 2;
48 const int VEHPARS_DEPARTLANE_SET = 2 << 1;
49 const int VEHPARS_DEPARTPOS_SET = 2 << 2;
50 const int VEHPARS_DEPARTSPEED_SET = 2 << 3;
51 const int VEHPARS_PERIODNUM_SET = 2 << 4;
52 const int VEHPARS_PERIODFREQ_SET = 2 << 5;
53 const int VEHPARS_ROUTE_SET = 2 << 6;
54 const int VEHPARS_ARRIVALLANE_SET = 2 << 7;
55 const int VEHPARS_ARRIVALPOS_SET = 2 << 8;
56 const int VEHPARS_ARRIVALSPEED_SET = 2 << 9;
57 const int VEHPARS_LINE_SET = 2 << 10;
58 const int VEHPARS_FROM_TAZ_SET = 2 << 11;
59 const int VEHPARS_TO_TAZ_SET = 2 << 12;
60 const int VEHPARS_FORCE_REROUTE = 2 << 13;
61 const int VEHPARS_PERSON_CAPACITY_SET = 2 << 14;
62 const int VEHPARS_PERSON_NUMBER_SET = 2 << 15;
63 const int VEHPARS_CONTAINER_NUMBER_SET = 2 << 16;
64 const int VEHPARS_DEPARTPOSLAT_SET = 2 << 17;
65 const int VEHPARS_ARRIVALPOSLAT_SET = 2 << 18;
66 const int VEHPARS_VIA_SET = 2 << 19;
67 
68 const int STOP_INDEX_END = -1;
69 const int STOP_INDEX_FIT = -2;
70 
71 const int STOP_END_SET = 1;
72 const int STOP_START_SET = 2;
73 const int STOP_TRIGGER_SET = 2 << 1;
74 const int STOP_PARKING_SET = 2 << 2;
75 const int STOP_EXPECTED_SET = 2 << 3;
76 const int STOP_CONTAINER_TRIGGER_SET = 2 << 4;
77 const int STOP_EXPECTED_CONTAINERS_SET = 2 << 5;
78 
79 
80 // ===========================================================================
81 // enum definitions
82 // ===========================================================================
98 };
99 
100 
122 };
123 
124 
146 };
147 
148 
172 };
173 
174 
190 };
191 
192 
206 };
207 
208 
226 };
227 
228 
246 };
247 
248 
262 };
263 
264 
265 // ===========================================================================
266 // struct definitions
267 // ===========================================================================
281 public:
287 
290 
295  bool wasSet(int what) const {
296  return (parametersSet & what) != 0;
297  }
298 
299 
308  void write(OutputDevice& dev, const OptionsCont& oc, const SumoXMLTag tag = SUMO_TAG_VEHICLE, const std::string& typeID = "") const;
309 
310 
316  bool defaultOptionOverrides(const OptionsCont& oc, const std::string& optionName) const;
317 
318 
319 
322 
332  static bool parseDepart(const std::string& val, const std::string& element, const std::string& id,
333  SUMOTime& depart, DepartDefinition& dd, std::string& error);
334 
335 
345  static bool parseDepartLane(const std::string& val, const std::string& element, const std::string& id,
346  int& lane, DepartLaneDefinition& dld, std::string& error);
347 
348 
358  static bool parseDepartPos(const std::string& val, const std::string& element, const std::string& id,
359  double& pos, DepartPosDefinition& dpd, std::string& error);
360 
361 
371  static bool parseDepartPosLat(const std::string& val, const std::string& element, const std::string& id,
372  double& pos, DepartPosLatDefinition& dpd, std::string& error);
373 
374 
384  static bool parseDepartSpeed(const std::string& val, const std::string& element, const std::string& id,
385  double& speed, DepartSpeedDefinition& dsd, std::string& error);
386 
387 
397  static bool parseArrivalLane(const std::string& val, const std::string& element, const std::string& id,
398  int& lane, ArrivalLaneDefinition& ald, std::string& error);
399 
400 
410  static bool parseArrivalPos(const std::string& val, const std::string& element, const std::string& id,
411  double& pos, ArrivalPosDefinition& apd, std::string& error);
412 
413 
423  static bool parseArrivalPosLat(const std::string& val, const std::string& element, const std::string& id,
424  double& pos, ArrivalPosLatDefinition& apd, std::string& error);
425 
426 
436  static bool parseArrivalSpeed(const std::string& val, const std::string& element, const std::string& id,
437  double& speed, ArrivalSpeedDefinition& asd, std::string& error);
439 
440 
448  static double interpretEdgePos(double pos, double maximumValue, SumoXMLAttr attr, const std::string& id);
449 
451  std::string id;
452 
454  std::string routeid;
456  std::string vtypeid;
458  mutable RGBColor color;
459 
462 
472  double departPos;
476  double departPosLat;
480  double departSpeed;
484 
485 
488 
494  double arrivalPos;
502  double arrivalSpeed;
506 
507 
510 
522 
523 
525  mutable std::string line;
526 
528  std::string fromTaz;
529 
531  std::string toTaz;
532 
536  struct Stop {
538  std::string lane;
540  std::string busstop;
542  std::string containerstop;
544  std::string parkingarea;
546  std::string chargingStation;
548  double startPos;
550  double endPos;
556  bool triggered;
560  bool parking;
562  std::set<std::string> awaitedPersons;
564  std::set<std::string> awaitedContainers;
566  std::vector<std::tuple<std::string, double, double> > accessPos;
568  int index;
570  int parametersSet = 0;
571 
577  void write(OutputDevice& dev) const;
578  };
579 
581  mutable std::vector<Stop> stops;
582 
584  mutable std::vector<std::string> via;
585 
588 
591 
593  mutable int parametersSet;
594 
595 };
596 
597 #endif
598 
599 /****************************************************************************/
600 
601 
The departure is person triggered.
const int VEHPARS_TO_TAZ_SET
The current lane shall be used.
const int STOP_CONTAINER_TRIGGER_SET
~SUMOVehicleParameter()
Destructor.
SUMOTime repetitionEnd
The time at which the flow ends (only needed when using repetitionProbability)
No information given; use default.
SumoXMLTag
Numbers representing SUMO-XML - element names.
RGBColor color
The vehicle&#39;s color, TraCI may change this.
A free lateral position is chosen.
The position is given.
long long int SUMOTime
Definition: SUMOTime.h:36
const int VEHPARS_FORCE_REROUTE
At the leftmost side of the lane.
static bool parseArrivalPosLat(const std::string &val, const std::string &element, const std::string &id, double &pos, ArrivalPosLatDefinition &apd, std::string &error)
Validates a given arrivalPosLat value.
The time is given.
std::string containerstop
(Optional) container stop if one is assigned to the stop
The vehicle is discarded if emission fails (not fully implemented yet)
int repetitionNumber
The number of times the vehicle shall be repeatedly inserted.
bool defaultOptionOverrides(const OptionsCont &oc, const std::string &optionName) const
Returns whether the defaults shall be used.
std::string vtypeid
The vehicle&#39;s type id.
bool parking
whether the vehicle is removed from the net while stopping
Tag for the last element in the enum for safe int casting.
ArrivalLaneDefinition
Possible ways to choose the arrival lane.
SUMOTime duration
The stopping duration.
ArrivalLaneDefinition arrivalLaneProcedure
Information how the vehicle shall choose the lane to arrive on.
Tag for the last element in the enum for safe int casting.
The speed is given.
The departure is container triggered.
At the leftmost side of the lane.
DepartLaneDefinition departLaneProcedure
Information how the vehicle shall choose the lane to depart from.
The position is given.
double repetitionProbability
The probability for emitting a vehicle per second.
The lateral position is chosen randomly.
Tag for the last element in the enum for safe int casting.
The least occupied lane is used.
If a fixed number of random choices fails, a free lateral position is chosen.
int parametersSet
Information for the router which parameter were set, TraCI may modify this (whe changing color) ...
int repetitionsDone
The number of times the vehicle was already inserted.
ArrivalPosLatDefinition arrivalPosLatProcedure
Information how the vehicle shall choose the lateral arrival position.
double arrivalPosLat
(optional) The lateral position the vehicle shall arrive on
const int VEHPARS_PERIODNUM_SET
The position is given.
const int VEHPARS_ARRIVALLANE_SET
The speed is chosen randomly.
Tag for the last element in the enum for safe int casting.
SUMOTime until
The time at which the vehicle may continue its journey.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
const int STOP_INDEX_FIT
The lane is chosen randomly.
std::set< std::string > awaitedPersons
IDs of persons the vehicle has to wait for until departing.
ArrivalSpeedDefinition arrivalSpeedProcedure
Information how the vehicle&#39;s end speed shall be chosen.
The arrival position is given.
DepartPosLatDefinition
ArrivalPosLatDefinition
Possible ways to choose the departure position.
The least occupied lane from best lanes.
The position is chosen randomly.
Tag for the last element in the enum for safe int casting.
std::string parkingarea
(Optional) parking area if one is assigned to the stop
SUMOTime repetitionOffset
The time offset between vehicle reinsertions.
The speed is given.
std::string toTaz
The vehicle&#39;s destination zone (district)
The lane is given.
std::vector< Stop > stops
List of the stops the vehicle will make, TraCI may add entries here.
const int VEHPARS_ARRIVALSPEED_SET
static double interpretEdgePos(double pos, double maximumValue, SumoXMLAttr attr, const std::string &id)
Interprets negative edge positions and fits them onto a given edge.
std::string busstop
(Optional) bus stop if one is assigned to the stop
double departSpeed
(optional) The initial speed of the vehicle
SUMOVehicleParameter()
Constructor.
Half the road length.
No information given; use default.
const int STOP_START_SET
DepartSpeedDefinition departSpeedProcedure
Information how the vehicle&#39;s initial speed shall be chosen.
DepartLaneDefinition
Possible ways to choose a lane on depart.
std::string routeid
The vehicle&#39;s route id.
double startPos
The stopping position start.
At the center of the lane.
DepartPosDefinition departPosProcedure
Information how the vehicle shall choose the departure position.
The least occupied lane from lanes which allow the continuation.
std::set< std::string > awaitedContainers
IDs of containers the vehicle has to wait for until departing.
const int VEHPARS_DEPARTSPEED_SET
std::string chargingStation
(Optional) charging station if one is assigned to the stop
The current speed is used.
bool triggered
whether an arriving person lets the vehicle continue
const int STOP_INDEX_END
At the rightmost side of the lane.
int parametersSet
Information for the output which parameter were set.
int arrivalLane
(optional) The lane the vehicle shall arrive on (not used yet)
const int VEHPARS_DEPARTPOSLAT_SET
SUMOTime depart
The vehicle&#39;s departure time.
The maximum speed is used.
DepartDefinition departProcedure
Information how the vehicle shall choose the depart time.
void write(OutputDevice &dev, const OptionsCont &oc, const SumoXMLTag tag=SUMO_TAG_VEHICLE, const std::string &typeID="") const
Writes the parameters as a beginning element.
const int VEHPARS_ROUTE_SET
std::string fromTaz
The vehicle&#39;s origin zone (district)
No information given; use default.
Tag for the last element in the enum for safe int casting.
const int STOP_EXPECTED_SET
static bool parseArrivalLane(const std::string &val, const std::string &element, const std::string &id, int &lane, ArrivalLaneDefinition &ald, std::string &error)
Validates a given arrivalLane value.
double endPos
The stopping position end.
An upper class for objects with additional parameters.
Definition: Parameterised.h:44
const int VEHPARS_COLOR_SET
int personNumber
The static number of persons in the vehicle when it departs (not including boarding persons) ...
If a fixed number of random choices fails, a free position is chosen.
bool containerTriggered
whether an arriving container lets the vehicle continue
const int VEHPARS_FROM_TAZ_SET
The rightmost lane the vehicle may use.
int departLane
(optional) The lane the vehicle shall depart from (index in edge)
std::string line
The vehicle&#39;s line (mainly for public transport)
double arrivalPos
(optional) The position the vehicle shall arrive on
DepartSpeedDefinition
Possible ways to choose the departure speed.
std::string lane
The lane to stop at.
const int STOP_END_SET
const int VEHPARS_VIA_SET
std::vector< std::string > via
List of the via-edges the vehicle must visit.
const int VEHPARS_ARRIVALPOSLAT_SET
double departPosLat
(optional) The lateral position the vehicle shall depart from
const int VEHPARS_LINE_SET
const int VEHPARS_ARRIVALPOS_SET
void write(OutputDevice &dev) const
Writes the stop as XML.
No information given; use default.
const int STOP_PARKING_SET
double departPos
(optional) The position the vehicle shall depart from
const int STOP_TRIGGER_SET
Structure representing possible vehicle parameter.
const int VEHPARS_PERIODFREQ_SET
const int STOP_EXPECTED_CONTAINERS_SET
static bool parseDepartPos(const std::string &val, const std::string &element, const std::string &id, double &pos, DepartPosDefinition &dpd, std::string &error)
Validates a given departPos value.
Definition of vehicle stop (position and duration)
static bool parseDepartPosLat(const std::string &val, const std::string &element, const std::string &id, double &pos, DepartPosLatDefinition &dpd, std::string &error)
Validates a given departPosLat value.
static bool parseArrivalSpeed(const std::string &val, const std::string &element, const std::string &id, double &speed, ArrivalSpeedDefinition &asd, std::string &error)
Validates a given arrivalSpeed value.
At the rightmost side of the lane.
At the center of the lane.
A storage for options typed value containers)
Definition: OptionsCont.h:92
Tag for the last element in the enum for safe int casting.
const int VEHPARS_DEPARTLANE_SET
int index
at which position in the stops list
static bool parseArrivalPos(const std::string &val, const std::string &element, const std::string &id, double &pos, ArrivalPosDefinition &apd, std::string &error)
Validates a given arrivalPos value.
No information given; use default.
The arrival lane is given.
int containerNumber
The static number of containers in the vehicle when it departs.
static bool parseDepartSpeed(const std::string &val, const std::string &element, const std::string &id, double &speed, DepartSpeedDefinition &dsd, std::string &error)
Validates a given departSpeed value.
No information given; use default.
bool wasSet(int what) const
Returns whether the given parameter was set.
const int VEHPARS_VTYPE_SET
description of a vehicle
No information given; use default.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:64
std::vector< std::tuple< std::string, double, double > > accessPos
lanes and positions connected to this stop
ArrivalPosDefinition
Possible ways to choose the arrival position.
double arrivalSpeed
(optional) The final speed of the vehicle (not used yet)
No information given; use default.
A free position is chosen.
const int VEHPARS_DEPARTPOS_SET
Insert behind the last vehicle as close as possible to still allow the specified departSpeed. Fallback to DEPART_POS_BASE if there is no vehicle on the departLane yet.
const int VEHPARS_PERSON_NUMBER_SET
ArrivalSpeedDefinition
Possible ways to choose the arrival speed.
Tag for the last element in the enum for safe int casting.
Tag for the last element in the enum for safe int casting.
DepartPosDefinition
Possible ways to choose the departure position.
const int VEHPARS_CONTAINER_NUMBER_SET
The maximum arrival position is used.
Back-at-zero position.
const int VEHPARS_PERSON_CAPACITY_SET
DepartDefinition
Possible ways to depart.
static bool parseDepart(const std::string &val, const std::string &element, const std::string &id, SUMOTime &depart, DepartDefinition &dd, std::string &error)
Validates a given depart value.
ArrivalPosDefinition arrivalPosProcedure
Information how the vehicle shall choose the arrival position.
std::string id
The vehicle&#39;s id.
static bool parseDepartLane(const std::string &val, const std::string &element, const std::string &id, int &lane, DepartLaneDefinition &dld, std::string &error)
Validates a given departLane value.
The arrival position is chosen randomly.
DepartPosLatDefinition departPosLatProcedure
Information how the vehicle shall choose the lateral departure position.