SUMO - Simulation of Urban MObility
SUMOVehicleParameter.h
Go to the documentation of this file.
1 /****************************************************************************/
10 // Structure representing possible vehicle parameter
11 /****************************************************************************/
12 // SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
13 // Copyright (C) 2001-2016 DLR (http://www.dlr.de/) and contributors
14 /****************************************************************************/
15 //
16 // This file is part of SUMO.
17 // SUMO is free software: you can redistribute it and/or modify
18 // it under the terms of the GNU General Public License as published by
19 // the Free Software Foundation, either version 3 of the License, or
20 // (at your option) any later version.
21 //
22 /****************************************************************************/
23 #ifndef SUMOVehicleParameter_h
24 #define SUMOVehicleParameter_h
25 
26 
27 // ===========================================================================
28 // included modules
29 // ===========================================================================
30 #ifdef _MSC_VER
31 #include <windows_config.h>
32 #else
33 #include <config.h>
34 #endif
35 
36 #include <string>
38 #include <utils/common/RGBColor.h>
39 #include <utils/common/SUMOTime.h>
41 
42 
43 // ===========================================================================
44 // class declarations
45 // ===========================================================================
46 class OutputDevice;
47 class OptionsCont;
48 
49 
50 // ===========================================================================
51 // value definitions
52 // ===========================================================================
53 const int VEHPARS_COLOR_SET = 1;
54 const int VEHPARS_VTYPE_SET = 2;
55 const int VEHPARS_DEPARTLANE_SET = 2 << 1;
56 const int VEHPARS_DEPARTPOS_SET = 2 << 2;
57 const int VEHPARS_DEPARTSPEED_SET = 2 << 3;
58 const int VEHPARS_PERIODNUM_SET = 2 << 4;
59 const int VEHPARS_PERIODFREQ_SET = 2 << 5;
60 const int VEHPARS_ROUTE_SET = 2 << 6;
61 const int VEHPARS_ARRIVALLANE_SET = 2 << 7;
62 const int VEHPARS_ARRIVALPOS_SET = 2 << 8;
63 const int VEHPARS_ARRIVALSPEED_SET = 2 << 9;
64 const int VEHPARS_LINE_SET = 2 << 10;
65 const int VEHPARS_FROM_TAZ_SET = 2 << 11;
66 const int VEHPARS_TO_TAZ_SET = 2 << 12;
67 const int VEHPARS_FORCE_REROUTE = 2 << 13;
68 const int VEHPARS_PERSON_CAPACITY_SET = 2 << 14;
69 const int VEHPARS_PERSON_NUMBER_SET = 2 << 15;
70 const int VEHPARS_CONTAINER_NUMBER_SET = 2 << 16;
71 const int VEHPARS_DEPARTPOSLAT_SET = 2 << 16;
72 
73 const int STOP_INDEX_END = -1;
74 const int STOP_INDEX_FIT = -2;
75 
76 const int STOP_END_SET = 1;
77 const int STOP_START_SET = 2;
78 const int STOP_TRIGGER_SET = 2 << 1;
79 const int STOP_PARKING_SET = 2 << 2;
80 const int STOP_EXPECTED_SET = 2 << 3;
81 const int STOP_CONTAINER_TRIGGER_SET = 2 << 4;
82 const int STOP_EXPECTED_CONTAINERS_SET = 2 << 5;
83 
84 
85 // ===========================================================================
86 // enum definitions
87 // ===========================================================================
103 };
104 
105 
127 };
128 
129 
151 };
152 
153 
177 };
178 
179 
195 };
196 
197 
211 };
212 
213 
229 };
230 
231 
245 };
246 
247 
248 // ===========================================================================
249 // struct definitions
250 // ===========================================================================
262 public:
268 
269 
274  bool wasSet(int what) const {
275  return (setParameter & what) != 0;
276  }
277 
278 
286  void write(OutputDevice& dev, const OptionsCont& oc, const SumoXMLTag tag = SUMO_TAG_VEHICLE) const;
287 
288 
294  bool defaultOptionOverrides(const OptionsCont& oc, const std::string& optionName) const;
295 
296 
297 
300 
310  static bool parseDepart(const std::string& val, const std::string& element, const std::string& id,
311  SUMOTime& depart, DepartDefinition& dd, std::string& error);
312 
313 
323  static bool parseDepartLane(const std::string& val, const std::string& element, const std::string& id,
324  int& lane, DepartLaneDefinition& dld, std::string& error);
325 
326 
336  static bool parseDepartPos(const std::string& val, const std::string& element, const std::string& id,
337  SUMOReal& pos, DepartPosDefinition& dpd, std::string& error);
338 
339 
349  static bool parseDepartPosLat(const std::string& val, const std::string& element, const std::string& id,
350  SUMOReal& pos, DepartPosLatDefinition& dpd, std::string& error);
351 
352 
362  static bool parseDepartSpeed(const std::string& val, const std::string& element, const std::string& id,
363  SUMOReal& speed, DepartSpeedDefinition& dsd, std::string& error);
364 
365 
375  static bool parseArrivalLane(const std::string& val, const std::string& element, const std::string& id,
376  int& lane, ArrivalLaneDefinition& ald, std::string& error);
377 
378 
388  static bool parseArrivalPos(const std::string& val, const std::string& element, const std::string& id,
389  SUMOReal& pos, ArrivalPosDefinition& apd, std::string& error);
390 
391 
401  static bool parseArrivalSpeed(const std::string& val, const std::string& element, const std::string& id,
402  SUMOReal& speed, ArrivalSpeedDefinition& asd, std::string& error);
404 
405 
413  static SUMOReal interpretEdgePos(SUMOReal pos, SUMOReal maximumValue, SumoXMLAttr attr, const std::string& id);
414 
416  std::string id;
417 
419  std::string routeid;
421  std::string vtypeid;
423  mutable RGBColor color;
424 
425 
428 
450 
451 
454 
468 
469 
472 
484 
485 
487  std::string line;
488 
490  std::string fromTaz;
491 
493  std::string toTaz;
494 
498  struct Stop {
500  std::string lane;
502  std::string busstop;
504  std::string containerstop;
506  std::string chargingStation;
516  bool triggered;
520  bool parking;
522  std::set<std::string> awaitedPersons;
524  std::set<std::string> awaitedContainers;
526  std::multimap<std::string, SUMOReal> accessPos;
528  int index;
531 
537  void write(OutputDevice& dev) const;
538  };
539 
541  std::vector<Stop> stops;
542 
544  std::vector<std::string> via;
545 
548 
551 
553  mutable int setParameter;
554 
555 
556 };
557 
558 #endif
559 
560 /****************************************************************************/
561 
562 
The departure is person triggered.
const int VEHPARS_TO_TAZ_SET
The current lane shall be used.
const int STOP_CONTAINER_TRIGGER_SET
SUMOTime repetitionEnd
The time at which the flow ends (only needed when using repetitionProbability)
No information given; use default.
SUMOReal repetitionProbability
The probability for emitting a vehicle per second.
SumoXMLTag
Numbers representing SUMO-XML - element names.
RGBColor color
The vehicle&#39;s color.
A free lateral position is chosen.
The position is given.
long long int SUMOTime
Definition: SUMOTime.h:43
const int VEHPARS_FORCE_REROUTE
At the leftmost side of the lane.
The time is given.
static bool parseDepartSpeed(const std::string &val, const std::string &element, const std::string &id, SUMOReal &speed, DepartSpeedDefinition &dsd, std::string &error)
Validates a given departSpeed value.
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.
std::string vtypeid
The vehicle&#39;s type id.
bool parking
whether the vehicle is removed from the net while stopping
static bool parseArrivalPos(const std::string &val, const std::string &element, const std::string &id, SUMOReal &pos, ArrivalPosDefinition &apd, std::string &error)
Validates a given arrivalPos value.
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.
The speed is given.
The departure is container triggered.
DepartLaneDefinition departLaneProcedure
Information how the vehicle shall choose the lane to depart from.
SUMOReal departSpeed
(optional) The initial speed of the vehicle
The position is given.
The lateral position is chosen randomly.
Tag for the last element in the enum for safe int casting.
SUMOReal arrivalSpeed
(optional) The final speed of the vehicle (not used yet)
The least occupied lane is used.
If a fixed number of random choices fails, a free lateral position is chosen.
int repetitionsDone
The number of times the vehicle was already inserted.
const int VEHPARS_PERIODNUM_SET
SUMOReal arrivalPos
(optional) The position the vehicle shall arrive on
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.
void write(OutputDevice &dev) const
Writes the stop as XML.
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
The least occupied lane from best lanes.
The position is chosen randomly.
Tag for the last element in the enum for safe int casting.
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.
const int VEHPARS_ARRIVALSPEED_SET
static SUMOReal interpretEdgePos(SUMOReal pos, SUMOReal 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
SUMOVehicleParameter()
Constructor.
No information given; use default.
const int STOP_START_SET
bool defaultOptionOverrides(const OptionsCont &oc, const std::string &optionName) const
Returns whether the defaults shall be used.
DepartSpeedDefinition departSpeedProcedure
Information how the vehicle&#39;s initial speed shall be chosen.
SUMOReal startPos
The stopping position start.
DepartLaneDefinition
Possible ways to choose a lane on depart.
std::string routeid
The vehicle&#39;s route id.
DepartPosDefinition departPosProcedure
Information how the vehicle shall choose the departure position.
The least occupied lane from lanes which allow the continuation.
bool wasSet(int what) const
Returns whether the given parameter was set.
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
SUMOReal endPos
The stopping position end.
The current speed is used.
bool triggered
whether an arriving person lets the vehicle continue
const int STOP_INDEX_END
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
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.
An upper class for objects with additional parameters.
Definition: Parameterised.h:47
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
static bool parseDepartPos(const std::string &val, const std::string &element, const std::string &id, SUMOReal &pos, DepartPosDefinition &dpd, std::string &error)
Validates a given departPos value.
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)
DepartSpeedDefinition
Possible ways to choose the departure speed.
std::string lane
The lane to stop at.
const int STOP_END_SET
std::vector< std::string > via
List of the via-edges the vehicle must visit.
const int VEHPARS_LINE_SET
static bool parseArrivalSpeed(const std::string &val, const std::string &element, const std::string &id, SUMOReal &speed, ArrivalSpeedDefinition &asd, std::string &error)
Validates a given arrivalSpeed value.
const int VEHPARS_ARRIVALPOS_SET
No information given; use default.
const int STOP_PARKING_SET
const int STOP_TRIGGER_SET
Structure representing possible vehicle parameter.
const int VEHPARS_PERIODFREQ_SET
const int STOP_EXPECTED_CONTAINERS_SET
int setParameter
Information for the router which parameter were set.
Definition of vehicle stop (position and duration)
At the rightmost side of the lane.
At the center of the lane.
A storage for options typed value containers)
Definition: OptionsCont.h:99
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
No information given; use default.
The arrival lane is given.
int containerNumber
The static number of containers in the vehicle when it departs.
int setParameter
Information for the output which parameter were set.
SUMOReal departPos
(optional) The position the vehicle shall depart from
static bool parseDepartPosLat(const std::string &val, const std::string &element, const std::string &id, SUMOReal &pos, DepartPosLatDefinition &dpd, std::string &error)
Validates a given departPosLat value.
const int VEHPARS_VTYPE_SET
No information given; use default.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:71
#define SUMOReal
Definition: config.h:213
ArrivalPosDefinition
Possible ways to choose the arrival position.
No information given; use default.
A free position is chosen.
std::multimap< std::string, SUMOReal > accessPos
lanes and positions connected to this stop
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
SUMOReal departPosLat
(optional) The lateral position the vehicle shall depart from
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.