SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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-sim.org/
13 // Copyright (C) 2001-2014 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>
37 #include "SUMOVehicleClass.h"
38 #include "RGBColor.h"
39 #include "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_TAZ_SET = 2 << 11;
66 const int VEHPARS_FORCE_REROUTE = 2 << 12;
67 const int VEHPARS_PERSON_CAPACITY_SET = 2 << 13;
68 const int VEHPARS_PERSON_NUMBER_SET = 2 << 14;
69 
70 const int STOP_INDEX_END = -1;
71 const int STOP_INDEX_FIT = -2;
72 
73 const int STOP_END_SET = 1;
74 const int STOP_START_SET = 2;
75 const int STOP_TRIGGER_SET = 2 << 1;
76 const int STOP_PARKING_SET = 2 << 2;
77 const int STOP_EXPECTED_SET = 2 << 3;
78 
79 
80 // ===========================================================================
81 // enum definitions
82 // ===========================================================================
96 };
97 
98 
118 };
119 
120 
146 };
147 
148 
164 };
165 
166 
180 };
181 
182 
198 };
199 
200 
214 };
215 
216 
217 // ===========================================================================
218 // struct definitions
219 // ===========================================================================
231 public:
237 
238 
243  bool wasSet(int what) const {
244  return (setParameter & what) != 0;
245  }
246 
247 
254  void write(OutputDevice& dev, const OptionsCont& oc) const;
255 
256 
262  void writeStops(OutputDevice& dev) const;
263 
269  bool defaultOptionOverrides(const OptionsCont& oc, const std::string& optionName) const;
270 
271 
272 
275 
285  static bool parseDepart(const std::string& val, const std::string& element, const std::string& id,
286  SUMOTime& depart, DepartDefinition& dd, std::string& error);
287 
288 
298  static bool parseDepartLane(const std::string& val, const std::string& element, const std::string& id,
299  int& lane, DepartLaneDefinition& dld, std::string& error);
300 
301 
311  static bool parseDepartPos(const std::string& val, const std::string& element, const std::string& id,
312  SUMOReal& pos, DepartPosDefinition& dpd, std::string& error);
313 
314 
324  static bool parseDepartSpeed(const std::string& val, const std::string& element, const std::string& id,
325  SUMOReal& speed, DepartSpeedDefinition& dsd, std::string& error);
326 
327 
337  static bool parseArrivalLane(const std::string& val, const std::string& element, const std::string& id,
338  int& lane, ArrivalLaneDefinition& ald, std::string& error);
339 
340 
350  static bool parseArrivalPos(const std::string& val, const std::string& element, const std::string& id,
351  SUMOReal& pos, ArrivalPosDefinition& apd, std::string& error);
352 
353 
363  static bool parseArrivalSpeed(const std::string& val, const std::string& element, const std::string& id,
364  SUMOReal& speed, ArrivalSpeedDefinition& asd, std::string& error);
366 
367 
375  static SUMOReal interpretEdgePos(SUMOReal pos, SUMOReal maximumValue, SumoXMLAttr attr, const std::string& id);
376 
378  std::string id;
379 
381  std::string routeid;
383  std::string vtypeid;
385  mutable RGBColor color;
386 
387 
390 
408 
409 
412 
426 
427 
430 
436 #ifdef HAVE_SUBSECOND_TIMESTEPS
438 #else
440 #endif
444 
445 
447  std::string line;
448 
450  std::string fromTaz;
451 
453  std::string toTaz;
454 
458  struct Stop {
460  std::string lane;
462  std::string busstop;
472  bool triggered;
474  bool parking;
476  std::set<std::string> awaitedPersons;
478  int index;
481  };
482 
484  std::vector<Stop> stops;
485 
487  unsigned int personCapacity;
488 
490  unsigned int personNumber;
491 
493  mutable int setParameter;
494 
495 
496 };
497 
498 #endif
499 
500 /****************************************************************************/
501 
The departure is person triggered.
The current lane shall be used.
No information given; use default.
SUMOReal repetitionProbability
The probability for emitting a vehicle per second.
RGBColor color
The vehicle's color.
const int VEHPARS_FORCE_REROUTE
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.
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'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.
ArrivalLaneDefinition
Possible ways to choose the arrival lane.
void writeStops(OutputDevice &dev) const
Writes the enclosed stops.
SUMOTime duration
The stopping duration.
ArrivalLaneDefinition arrivalLaneProcedure
Information how the vehicle shall choose the lane to arrive on.
The speed is given.
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.
unsigned int personCapacity
The vehicle's capacity (persons)
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.
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.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
const int STOP_INDEX_FIT
The lane is chosen randomly.
unsigned int personNumber
The number of persons in the vehicle.
std::set< std::string > awaitedPersons
IDs of persons the vehicle has to wait for until departing.
ArrivalSpeedDefinition arrivalSpeedProcedure
Information how the vehicle's end speed shall be chosen.
The arrival position is given.
SUMOReal repetitionOffset
The time offset between vehicle reinsertions.
The least occupied lane from best lanes.
The position is chosen randomly.
Tag for the last element in the enum for safe int casting.
Generic max-flow insertion by P.Wagner.
The speed is given.
A gap is chosen where the maximum speed may be achieved.
std::string toTaz
The vehicle'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.
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'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'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.
const int VEHPARS_DEPARTSPEED_SET
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)
SUMOTime depart
The vehicle's departure time.
The maximum speed is used.
DepartDefinition departProcedure
Information how the vehicle shall choose the depart time.
const int VEHPARS_ROUTE_SET
std::string fromTaz
The vehicle'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
If a fixed number of random choices fails, a free position is chosen.
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.
int departLane
(optional) The lane the vehicle shall depart from (index in edge)
std::string line
The vehicle'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
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
int setParameter
Information for the router which parameter were set.
Definition of vehicle stop (position and duration)
A storage for options typed value containers)
Definition: OptionsCont.h:108
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 setParameter
Information for the output which parameter were set.
int SUMOTime
Definition: SUMOTime.h:43
SUMOReal departPos
(optional) The position the vehicle shall depart from
void write(OutputDevice &dev, const OptionsCont &oc) const
Writes the parameters as a beginning element.
const int VEHPARS_TAZ_SET
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:215
ArrivalPosDefinition
Possible ways to choose the arrival position.
No information given; use default.
A free position is chosen.
const int VEHPARS_DEPARTPOS_SET
Simple max-flow insertion by P.Wagner.
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.
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'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.