SUMO - Simulation of Urban MObility
SUMOVTypeParameter.h
Go to the documentation of this file.
1 /****************************************************************************/
9 // Structure representing possible vehicle parameter
10 /****************************************************************************/
11 // SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
12 // Copyright (C) 2001-2017 DLR (http://www.dlr.de/) and contributors
13 /****************************************************************************/
14 //
15 // This file is part of SUMO.
16 // SUMO is free software: you can redistribute it and/or modify
17 // it under the terms of the GNU General Public License as published by
18 // the Free Software Foundation, either version 3 of the License, or
19 // (at your option) any later version.
20 //
21 /****************************************************************************/
22 #ifndef SUMOVTypeParameter_h
23 #define SUMOVTypeParameter_h
24 
25 
26 // ===========================================================================
27 // included modules
28 // ===========================================================================
29 #ifdef _MSC_VER
30 #include <windows_config.h>
31 #else
32 
33 #include <config.h>
34 
35 #endif
36 
37 #include <string>
38 #include <map>
40 #include <utils/common/RGBColor.h>
41 #include <utils/common/SUMOTime.h>
44 
45 // ===========================================================================
46 // class declarations
47 // ===========================================================================
48 class OutputDevice;
49 
50 class OptionsCont;
51 
52 
53 // ===========================================================================
54 // value definitions
55 // ===========================================================================
56 const int VTYPEPARS_LENGTH_SET = 1;
57 const int VTYPEPARS_MINGAP_SET = 1 << 1;
58 const int VTYPEPARS_MAXSPEED_SET = 1 << 2;
59 const int VTYPEPARS_PROBABILITY_SET = 1 << 3;
60 const int VTYPEPARS_SPEEDFACTOR_SET = 1 << 4;
61 const int VTYPEPARS_EMISSIONCLASS_SET = 1 << 5;
62 const int VTYPEPARS_COLOR_SET = 1 << 6;
63 const int VTYPEPARS_VEHICLECLASS_SET = 1 << 7;
64 const int VTYPEPARS_WIDTH_SET = 1 << 8;
65 const int VTYPEPARS_HEIGHT_SET = 1 << 9;
66 const int VTYPEPARS_SHAPE_SET = 1 << 10;
67 const int VTYPEPARS_OSGFILE_SET = 1 << 11;
68 const int VTYPEPARS_IMGFILE_SET = 1 << 12;
69 const int VTYPEPARS_IMPATIENCE_SET = 1 << 13;
70 const int VTYPEPARS_LANE_CHANGE_MODEL_SET = 1 << 14;
71 const int VTYPEPARS_PERSON_CAPACITY = 1 << 15;
72 const int VTYPEPARS_BOARDING_DURATION = 1 << 16;
73 const int VTYPEPARS_CONTAINER_CAPACITY = 1 << 17;
74 const int VTYPEPARS_LOADING_DURATION = 1 << 18;
75 const int VTYPEPARS_CAR_FOLLOW_MODEL = 1 << 19;
76 const int VTYPEPARS_MAXSPEED_LAT_SET = 1 << 20;
77 const int VTYPEPARS_LATALIGNMENT_SET = 1 << 21;
78 const int VTYPEPARS_MINGAP_LAT_SET = 1 << 22;
79 
80 
81 // ===========================================================================
82 // struct definitions
83 // ===========================================================================
89 public:
94  SUMOVTypeParameter(const std::string& vtid, const SUMOVehicleClass vc = SVC_IGNORING);
95 
96 
101  bool wasSet(int what) const {
102  return (setParameter & what) != 0;
103  }
104 
105 
111  void write(OutputDevice& dev) const;
112 
115  void validateCFParameter() const;
116 
117 
123  double getCFParam(const SumoXMLAttr attr, const double defaultValue) const;
124 
130  std::string getCFParamString(const SumoXMLAttr attr, const std::string defaultValue) const;
131 
137  double getLCParam(const SumoXMLAttr attr, const double defaultValue) const;
138 
139 
141  std::string id;
142 
144  double length;
146  double minGap;
148  double maxSpeed;
160  double impatience;
169 
172 
174  double width;
175 
177  double height;
178 
181 
183  std::string osgFile;
184 
186  std::string imgFile;
188 
189 
192 
194  typedef std::map<SumoXMLAttr, std::string> SubParams;
196  SubParams cfParameter;
198  SubParams lcParameter;
199 
202 
204  double maxSpeedLat;
208  double minGapLat;
209 
212 
213 
215  mutable bool saved;
216 
218  mutable bool onlyReferenced;
219 
225  static double getDefaultAccel(const SUMOVehicleClass vc = SVC_IGNORING);
226 
232  static double getDefaultDecel(const SUMOVehicleClass vc = SVC_IGNORING);
233 
239  static double getDefaultEmergencyDecel(const SUMOVehicleClass vc = SVC_IGNORING);
240 
246  static double getDefaultImperfection(const SUMOVehicleClass vc = SVC_IGNORING);
247 
249  static const SUMOVTypeParameter& getDefault();
250 
251 };
252 
253 #endif
254 
255 /****************************************************************************/
256 
const int VTYPEPARS_MAXSPEED_SET
const int VTYPEPARS_MINGAP_SET
SumoXMLTag
Numbers representing SUMO-XML - element names.
SumoXMLTag cfModel
The enum-representation of the car-following model to use.
const int VTYPEPARS_LATALIGNMENT_SET
double impatience
The vehicle&#39;s impatience (willingness to obstruct others)
std::map< SumoXMLAttr, std::string > SubParams
sub-model parameters
SUMOVehicleClass
Definition of vehicle classes to differ between different lane usage and authority types...
SUMOVehicleShape shape
This class&#39; shape.
Structure representing possible vehicle parameter.
const int VTYPEPARS_MINGAP_LAT_SET
bool saved
Information whether this type was already saved (needed by routers)
SUMOVTypeParameter(const std::string &vtid, const SUMOVehicleClass vc=SVC_IGNORING)
Constructor.
double defaultProbability
The probability when being added to a distribution without an explicit probability.
int containerCapacity
The container capacity of the vehicle.
const int VTYPEPARS_BOARDING_DURATION
SUMOVehicleClass vehicleClass
The vehicle&#39;s class.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
const int VTYPEPARS_CAR_FOLLOW_MODEL
const int VTYPEPARS_OSGFILE_SET
const int VTYPEPARS_MAXSPEED_LAT_SET
const int VTYPEPARS_PROBABILITY_SET
LateralAlignment
Numbers representing special SUMO-XML-attribute values Information how vehicles align themselves with...
static double getDefaultAccel(const SUMOVehicleClass vc=SVC_IGNORING)
Returns the default acceleration for the given vehicle class This needs to be a function because the ...
double height
This class&#39; height.
const int VTYPEPARS_LANE_CHANGE_MODEL_SET
static double getDefaultImperfection(const SUMOVehicleClass vc=SVC_IGNORING)
Returns the default driver&#39;s imperfection (sigma or epsilon in Krauss&#39; model) for the given vehicle c...
double getLCParam(const SumoXMLAttr attr, const double defaultValue) const
Returns the named value from the map, or the default if it is not contained there.
LaneChangeModel
bool wasSet(int what) const
Returns whether the given parameter was set.
double maxSpeed
The vehicle type&#39;s maximum speed [m/s].
double width
This class&#39; width.
SUMOTime boardingDuration
The time a person needs to board the vehicle.
std::string osgFile
3D model file for this class
int SUMOEmissionClass
std::string imgFile
Image file for this class.
void validateCFParameter() const
Validates stored car-following parameter.
static double getDefaultDecel(const SUMOVehicleClass vc=SVC_IGNORING)
Returns the default deceleration for the given vehicle class This needs to be a function because the ...
const int VTYPEPARS_LOADING_DURATION
const int VTYPEPARS_CONTAINER_CAPACITY
An upper class for objects with additional parameters.
Definition: Parameterised.h:51
bool onlyReferenced
Information whether this is a type-stub, being only referenced but not defined (needed by routers) ...
static double getDefaultEmergencyDecel(const SUMOVehicleClass vc=SVC_IGNORING)
Returns the default emergency deceleration for the given vehicle class This needs to be a function be...
const int VTYPEPARS_SPEEDFACTOR_SET
double maxSpeedLat
The vehicle type&#39;s maximum lateral speed [m/s].
double getCFParam(const SumoXMLAttr attr, const double defaultValue) const
Returns the named value from the map, or the default if it is not contained there.
int personCapacity
The person capacity of the vehicle.
int setParameter
Information for the router which parameter were set.
double minGapLat
The vehicle type&#39;s minimum lateral gap [m].
void write(OutputDevice &dev) const
Writes the vtype.
std::string getCFParamString(const SumoXMLAttr attr, const std::string defaultValue) const
Returns the named value from the map, or the default if it is not contained there.
SUMOVehicleShape
Definition of vehicle classes to differ between different appearences.
const int VTYPEPARS_IMGFILE_SET
SubParams cfParameter
Car-following parameter.
SUMOTime loadingDuration
The time a container needs to get loaded on the vehicle.
RGBColor color
The color.
A storage for options typed value containers)
Definition: OptionsCont.h:99
std::string id
The vehicle type&#39;s id.
const int VTYPEPARS_PERSON_CAPACITY
LateralAlignment latAlignment
The vehicles desired lateral alignment.
double minGap
This class&#39; free space in front of the vehicle itself.
const int VTYPEPARS_HEIGHT_SET
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:71
long long int SUMOTime
Definition: TraCIDefs.h:52
const int VTYPEPARS_WIDTH_SET
LaneChangeModel lcModel
The lane-change model to use.
static const SUMOVTypeParameter & getDefault()
return the default parameters, this is a function due to the http://www.parashift.com/c++-faq/static-init-order.html
const int VTYPEPARS_LENGTH_SET
const int VTYPEPARS_VEHICLECLASS_SET
const int VTYPEPARS_EMISSIONCLASS_SET
const int VTYPEPARS_COLOR_SET
Distribution_Parameterized speedFactor
The factor by which the maximum speed may deviate from the allowed max speed on the street...
const int VTYPEPARS_SHAPE_SET
double length
The physical vehicle length.
SubParams lcParameter
Lane-changing parameter.
SUMOEmissionClass emissionClass
The emission class of this vehicle.
vehicles ignoring classes
const int VTYPEPARS_IMPATIENCE_SET