Eclipse SUMO - Simulation of Urban MObility
SUMOVTypeParameter.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-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/****************************************************************************/
20// Structure representing possible vehicle parameter
21/****************************************************************************/
22#pragma once
23#include <config.h>
24
25#include <string>
26#include <map>
32
33// ===========================================================================
34// class declarations
35// ===========================================================================
36class OutputDevice;
37class OptionsCont;
38
39
40// ===========================================================================
41// value definitions
42// ===========================================================================
43const long long int VTYPEPARS_LENGTH_SET = 1;
44const long long int VTYPEPARS_MINGAP_SET = 1 << 1;
45const long long int VTYPEPARS_MAXSPEED_SET = 1 << 2;
46const long long int VTYPEPARS_PROBABILITY_SET = 1 << 3;
47const long long int VTYPEPARS_SPEEDFACTOR_SET = 1 << 4;
48const long long int VTYPEPARS_EMISSIONCLASS_SET = 1 << 5;
49const long long int VTYPEPARS_COLOR_SET = 1 << 6;
50const long long int VTYPEPARS_VEHICLECLASS_SET = 1 << 7;
51const long long int VTYPEPARS_WIDTH_SET = 1 << 8;
52const long long int VTYPEPARS_HEIGHT_SET = 1 << 9;
53const long long int VTYPEPARS_SHAPE_SET = 1 << 10;
54const long long int VTYPEPARS_OSGFILE_SET = 1 << 11;
55const long long int VTYPEPARS_IMGFILE_SET = 1 << 12;
56const long long int VTYPEPARS_IMPATIENCE_SET = 1 << 13;
57const long long int VTYPEPARS_LANE_CHANGE_MODEL_SET = 1 << 14;
58const long long int VTYPEPARS_PERSON_CAPACITY = 1 << 15;
59const long long int VTYPEPARS_BOARDING_DURATION = 1 << 16;
60const long long int VTYPEPARS_CONTAINER_CAPACITY = 1 << 17;
61const long long int VTYPEPARS_LOADING_DURATION = 1 << 18;
62const long long int VTYPEPARS_CAR_FOLLOW_MODEL = 1 << 19;
63const long long int VTYPEPARS_MAXSPEED_LAT_SET = 1 << 20;
64const long long int VTYPEPARS_LATALIGNMENT_SET = 1 << 21;
65const long long int VTYPEPARS_MINGAP_LAT_SET = 1 << 22;
66const long long int VTYPEPARS_ACTIONSTEPLENGTH_SET = 1 << 23;
67const long long int VTYPEPARS_DESIRED_MAXSPEED_SET = 1 << 24;
68const long long int VTYPEPARS_CARRIAGE_LENGTH_SET = 1 << 25;
69const long long int VTYPEPARS_LOCOMOTIVE_LENGTH_SET = 1 << 26;
70const long long int VTYPEPARS_CARRIAGE_GAP_SET = 1 << 27;
71const long long int VTYPEPARS_MANEUVER_ANGLE_TIMES_SET = 1 << 28;
72const long long int VTYPEPARS_FRONT_SEAT_POS_SET = 1 << 29;
73const long long int VTYPEPARS_SCALE_SET = 1 << 30;
74const long long int VTYPEPARS_MASS_SET = (long long int)1 << 31;
75const long long int VTYPEPARS_TTT_SET = (long long int)1 << 32;
76const long long int VTYPEPARS_TTT_BIDI_SET = (long long int)1 << 33;
77
78
81
82
83// ===========================================================================
84// enum definitions
85// ===========================================================================
92 DEFAULT,
94 GIVEN,
96 RIGHT,
98 CENTER,
100 ARBITRARY,
102 NICE,
104 COMPACT,
106 LEFT
107};
108
109
110// ===========================================================================
111// struct definitions
112// ===========================================================================
118
119public:
124
126 double length;
127
129 double minGap;
130
132 double maxSpeed;
133
136
138 double width;
139
141 double height;
142
145
148
150 double mass;
151
154
157
160
162 std::string osgFile;
163
166
169
172
173 private:
176 };
177
182 SUMOVTypeParameter(const std::string& vtid, const SUMOVehicleClass vc = SVC_IGNORING);
183
186
191 bool wasSet(long long int what) const {
192 return (parametersSet & what) != 0;
193 }
194
200 void write(OutputDevice& dev) const;
201
207 double getCFParam(const SumoXMLAttr attr, const double defaultValue) const;
208
214 std::string getCFParamString(const SumoXMLAttr attr, const std::string defaultValue) const;
215
221 double getLCParam(const SumoXMLAttr attr, const double defaultValue) const;
222
228 std::string getLCParamString(const SumoXMLAttr attr, const std::string& defaultValue) const;
229
231 typedef std::map<SumoXMLAttr, std::string> SubParams;
232
234 const SubParams& getLCParams() const;
235
241 double getJMParam(const SumoXMLAttr attr, const double defaultValue) const;
242
248 std::string getJMParamString(const SumoXMLAttr attr, const std::string defaultValue) const;
249
250 void cacheParamRestrictions(const std::vector<std::string>& restrictionKeys);
251
254
256 std::string id;
257
259 double length;
260
262 double minGap;
263
265 double maxSpeed;
266
269
273
276
279
282
284 double mass;
285
288
291
294
297
300
303
306
308 double scale;
309
312
314 double width;
315
317 double height;
318
321
323 std::string osgFile;
324
326 std::string imgFile;
328
329
332
335
338
341
344
347
350
353
355 double minGapLat;
356
361
364
367
370
372 long long int parametersSet;
373
375 mutable bool saved;
376
379
381 std::vector<double> paramRestrictions;
382
384 inline double getLength() const {
385 return length;
386 }
387
393 static double getDefaultAccel(const SUMOVehicleClass vc = SVC_IGNORING);
394
400 static double getDefaultDecel(const SUMOVehicleClass vc = SVC_IGNORING);
401
408 static double getDefaultEmergencyDecel(const SUMOVehicleClass vc, double decel, double defaultOption);
409
415 static double getDefaultImperfection(const SUMOVehicleClass vc = SVC_IGNORING);
416
418 static const SUMOVTypeParameter& getDefault();
419
426 static bool parseLatAlignment(const std::string& val, double& lao, LatAlignmentDefinition& lad);
427
428 static inline bool isValidLatAlignment(const std::string& val) {
429 double lao;
431 return SUMOVTypeParameter::parseLatAlignment(val, lao, lad);
432 }
433
435 // XXX: does not include valid float strings
436 static inline std::vector<std::string> getLatAlignmentStrings() {
437 std::vector<std::string> result;
438 result.push_back("right");
439 result.push_back("center");
440 result.push_back("arbitrary");
441 result.push_back("nice");
442 result.push_back("compact");
443 result.push_back("left");
444 return result;
445 }
446
448 std::map<int, std::pair<SUMOTime, SUMOTime>> myManoeuverAngleTimes;
449
459 void setManoeuverAngleTimes(const SUMOVehicleClass vclass);
460
465 SUMOTime getEntryManoeuvreTime(const int angle) const;
466
471 SUMOTime getExitManoeuvreTime(const int angle) const;
472
476 std::string getManoeuverAngleTimesS() const;
477
479 SUMOTime getTimeToTeleport(SUMOTime defaultValue) const;
480
482 SUMOTime getTimeToTeleportBidi(SUMOTime defaultValue) const;
483};
long long int SUMOTime
Definition: GUI.h:36
@ DEFAULT
default cursor
const long long int VTYPEPARS_TTT_SET
const long long int VTYPEPARS_SHAPE_SET
const long long int VTYPEPARS_LOADING_DURATION
const long long int VTYPEPARS_TTT_BIDI_SET
const long long int VTYPEPARS_SCALE_SET
const long long int VTYPEPARS_PERSON_CAPACITY
const long long int VTYPEPARS_CAR_FOLLOW_MODEL
const long long int VTYPEPARS_FRONT_SEAT_POS_SET
const long long int VTYPEPARS_WIDTH_SET
const long long int VTYPEPARS_CARRIAGE_LENGTH_SET
const long long int VTYPEPARS_ACTIONSTEPLENGTH_SET
const long long int VTYPEPARS_MAXSPEED_LAT_SET
const long long int VTYPEPARS_MAXSPEED_SET
const long long int VTYPEPARS_EMISSIONCLASS_SET
const int VTYPEPARS_DEFAULT_EMERGENCYDECEL_DEFAULT
const long long int VTYPEPARS_LATALIGNMENT_SET
const long long int VTYPEPARS_COLOR_SET
const long long int VTYPEPARS_LANE_CHANGE_MODEL_SET
const long long int VTYPEPARS_DESIRED_MAXSPEED_SET
const long long int VTYPEPARS_OSGFILE_SET
const long long int VTYPEPARS_MANEUVER_ANGLE_TIMES_SET
const long long int VTYPEPARS_SPEEDFACTOR_SET
const long long int VTYPEPARS_CARRIAGE_GAP_SET
const long long int VTYPEPARS_MINGAP_SET
const long long int VTYPEPARS_PROBABILITY_SET
const long long int VTYPEPARS_HEIGHT_SET
const int VTYPEPARS_DEFAULT_EMERGENCYDECEL_DECEL
const long long int VTYPEPARS_MASS_SET
const long long int VTYPEPARS_BOARDING_DURATION
LatAlignmentDefinition
Possible ways to choose the lateral alignment, i.e., how vehicles align themselves within their lane.
@ ARBITRARY
maintain the current alignment
@ NICE
align with the closest sublane border
@ COMPACT
align with the rightmost sublane that allows keeping the current speed
const long long int VTYPEPARS_VEHICLECLASS_SET
const long long int VTYPEPARS_IMPATIENCE_SET
const long long int VTYPEPARS_LENGTH_SET
const long long int VTYPEPARS_IMGFILE_SET
const long long int VTYPEPARS_CONTAINER_CAPACITY
const long long int VTYPEPARS_MINGAP_LAT_SET
const long long int VTYPEPARS_LOCOMOTIVE_LENGTH_SET
SUMOVehicleClass
Definition of vehicle classes to differ between different lane usage and authority types.
@ SVC_IGNORING
vehicles ignoring classes
int SUMOEmissionClass
SUMOVehicleShape
Definition of vehicle classes to differ between different appearances.
@ RIGHT
At the rightmost side of the lane.
@ LEFT
At the leftmost side of the lane.
@ CENTER
At the center of the lane.
@ GIVEN
The time is given.
SumoXMLTag
Numbers representing SUMO-XML - element names.
LaneChangeModel
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
A storage for options typed value containers)
Definition: OptionsCont.h:89
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
An upper class for objects with additional parameters.
Definition: Parameterised.h:41
Structure representing possible vehicle parameter.
static bool isValidLatAlignment(const std::string &val)
SUMOTime getExitManoeuvreTime(const int angle) const
Returns the time that will be needed for the vehicle type to execute the (exit) manoeuvre (and be blo...
double width
This class' width.
SubParams cfParameter
Car-following parameter.
void write(OutputDevice &dev) const
Writes the vtype.
double defaultProbability
The probability when being added to a distribution without an explicit probability.
SUMOTime actionStepLength
The vehicle type's default actionStepLength [ms], i.e. the interval between two control actions....
void cacheParamRestrictions(const std::vector< std::string > &restrictionKeys)
bool saved
Information whether this type was already saved (needed by routers)
SUMOTime getTimeToTeleport(SUMOTime defaultValue) const
return time-to-teleport (either custom or default)
bool wasSet(long long int what) const
Returns whether the given parameter was set.
double height
This class' height.
double desiredMaxSpeed
The vehicle type's desired maximum speed [m/s].
SUMOEmissionClass emissionClass
The emission class of this vehicle.
double frontSeatPos
the offset of the first person seat from the front of the vehicle
double latAlignmentOffset
(optional) The vehicle's desired lateral alignment as offset in m from center line
std::string getJMParamString(const SumoXMLAttr attr, const std::string defaultValue) const
Returns the named value from the map, or the default if it is not contained there.
double carriageLength
the length of train carriages and locomotive
SUMOTime getTimeToTeleportBidi(SUMOTime defaultValue) const
return time-to-teleport.bidi (either custom or default)
double length
The physical vehicle length.
double maxSpeedLat
The vehicle type's maximum lateral speed [m/s].
virtual ~SUMOVTypeParameter()
virtual destructor
std::vector< double > paramRestrictions
cached value of parameters which may restrict access to certain edges
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 ...
SUMOTime getEntryManoeuvreTime(const int angle) const
Returns the time that will be needed for the vehicle type to execute the (entry) manoeuvre (and be bl...
RGBColor color
The color.
long long int parametersSet
Information for the router which parameter were set.
double minGap
This class' free space in front of the vehicle itself.
std::map< SumoXMLAttr, std::string > SubParams
sub-model parameters
std::string imgFile
Image file for this class.
void initRailVisualizationParameters()
init Rail Visualization Parameters
SUMOVehicleShape shape
This class' shape.
int personCapacity
The person capacity of the vehicle.
Distribution_Parameterized speedFactor
The factor by which the maximum speed may deviate from the allowed max speed on the street.
bool onlyReferenced
Information whether this is a type-stub, being only referenced but not defined (needed by routers)
double getLength() const
satisfy vType / router template requirements
double scale
individual scaling factor (-1 for undefined)
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.
SUMOTime timeToTeleport
the custom time-to-teleport for this type
std::string osgFile
3D model file for this class
double maxSpeed
The vehicle type's (technical) maximum speed [m/s].
static double getDefaultEmergencyDecel(const SUMOVehicleClass vc, double decel, double defaultOption)
Returns the default emergency deceleration for the given vehicle class This needs to be a function be...
SUMOTime timeToTeleportBidi
the custom time-to-teleport.bidi for this type
void setManoeuverAngleTimes(const SUMOVehicleClass vclass)
Initialise the default mapping between manoeuver angle and times dependant on vehicle class.
int containerCapacity
The container capacity of the vehicle.
static const SUMOVTypeParameter & getDefault()
return the default parameters, this is a function due to the http://www.parashift....
SUMOTime boardingDuration
The time a person needs to board the vehicle.
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.
static std::vector< std::string > getLatAlignmentStrings()
return all valid strings for latAlignment
double minGapLat
The vehicle type's minimum lateral gap [m].
SUMOVehicleClass vehicleClass
The vehicle's class.
SUMOVTypeParameter(const std::string &vtid, const SUMOVehicleClass vc=SVC_IGNORING)
Constructor.
double getJMParam(const SumoXMLAttr attr, const double defaultValue) const
Returns the named value from the map, or the default if it is not contained there.
double mass
The mass.
SUMOTime loadingDuration
The time a container needs to get loaded on the vehicle.
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.
std::string id
The vehicle type's id.
SumoXMLTag cfModel
The enum-representation of the car-following model to use.
const SubParams & getLCParams() const
Returns the LC parameter.
std::string getLCParamString(const SumoXMLAttr attr, const std::string &defaultValue) const
Returns the named value from the map, or the default if it is not contained there.
SubParams lcParameter
Lane-changing parameter.
LatAlignmentDefinition latAlignmentProcedure
Information on how the vehicle shall choose the lateral alignment.
static double getDefaultImperfection(const SUMOVehicleClass vc=SVC_IGNORING)
Returns the default driver's imperfection (sigma or epsilon in Krauss' model) for the given vehicle c...
SubParams jmParameter
Junction-model parameter.
double impatience
The vehicle's impatience (willingness to obstruct others)
std::string getManoeuverAngleTimesS() const
Returns myManoeuverAngleTimes as a string for xml output.
std::map< int, std::pair< SUMOTime, SUMOTime > > myManoeuverAngleTimes
Map of manoeuver angles versus the times (entry, exit) to execute the manoeuver.
LaneChangeModel lcModel
The lane-change model to use.
static bool parseLatAlignment(const std::string &val, double &lao, LatAlignmentDefinition &lad)
Parses and validates a given latAlignment value.
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 ...
struct for default values that depend of VClass
int personCapacity
The person capacity of the vehicle.
double carriageLength
the length of train carriages
double desiredMaxSpeed
The vehicle type's desired maximum speed [m/s].
std::string osgFile
3D model file for this class
SUMOEmissionClass emissionClass
The emission class of this vehicle.
double minGap
This class' free space in front of the vehicle itself.
int containerCapacity
The container capacity of the vehicle.
double maxSpeed
The vehicle type's maximum speed [m/s] (technical limit, not subject to speed deviation)
Distribution_Parameterized speedFactor
The factor by which the maximum speed may deviate from the allowed max speed on the street.
double length
The physical vehicle length.
SUMOVehicleShape shape
This class' shape.
LatAlignmentDefinition latAlignmentProcedure
the lateral alignment procedure
double locomotiveLength
the length of train locomotive