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-2015 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 #include <config.h>
33 #endif
34 
35 #include <string>
36 #include <map>
38 #include <utils/common/RGBColor.h>
39 #include <utils/common/SUMOTime.h>
41 
42 // ===========================================================================
43 // class declarations
44 // ===========================================================================
45 class OutputDevice;
46 class OptionsCont;
47 
48 
49 // ===========================================================================
50 // value definitions
51 // ===========================================================================
52 const int VTYPEPARS_LENGTH_SET = 1;
53 const int VTYPEPARS_MINGAP_SET = 2;
54 const int VTYPEPARS_MAXSPEED_SET = 2 << 2;
55 const int VTYPEPARS_PROBABILITY_SET = 2 << 3;
56 const int VTYPEPARS_SPEEDFACTOR_SET = 2 << 4;
57 const int VTYPEPARS_SPEEDDEVIATION_SET = 2 << 5;
58 const int VTYPEPARS_EMISSIONCLASS_SET = 2 << 6;
59 const int VTYPEPARS_COLOR_SET = 2 << 7;
60 const int VTYPEPARS_VEHICLECLASS_SET = 2 << 8;
61 const int VTYPEPARS_WIDTH_SET = 2 << 9;
62 const int VTYPEPARS_HEIGHT_SET = 2 << 10;
63 const int VTYPEPARS_SHAPE_SET = 2 << 11;
64 const int VTYPEPARS_OSGFILE_SET = 2 << 12;
65 const int VTYPEPARS_IMGFILE_SET = 2 << 13;
66 const int VTYPEPARS_IMPATIENCE_SET = 2 << 14;
67 const int VTYPEPARS_LANE_CHANGE_MODEL_SET = 2 << 15;
68 const int VTYPEPARS_PERSON_CAPACITY = 2 << 16;
69 const int VTYPEPARS_BOARDING_DURATION = 2 << 17;
70 const int VTYPEPARS_CONTAINER_CAPACITY = 2 << 18;
71 const int VTYPEPARS_LOADING_DURATION = 2 << 19;
72 
73 
74 // ===========================================================================
75 // struct definitions
76 // ===========================================================================
82 public:
87  SUMOVTypeParameter(const std::string& vtid, const SUMOVehicleClass vc = SVC_IGNORING);
88 
89 
94  bool wasSet(int what) const {
95  return (setParameter & what) != 0;
96  }
97 
98 
104  void write(OutputDevice& dev) const;
105 
108  void validateCFParameter() const;
109 
110 
116  SUMOReal get(const SumoXMLAttr attr, const SUMOReal defaultValue) const;
117 
118 
120  std::string id;
121 
143  unsigned int personCapacity;
145  unsigned int containerCapacity;
150 
151 
152 
155 
158 
161 
164 
166  std::string osgFile;
167 
169  std::string imgFile;
171 
172 
175 
177  typedef std::map<SumoXMLAttr, SUMOReal> CFParams;
178  CFParams cfParameter;
179 
182 
185 
186 
188  mutable bool saved;
189 
191  mutable bool onlyReferenced;
192 
199 
206 
213 
215  static const SUMOVTypeParameter& getDefault();
216 
217 };
218 
219 #endif
220 
221 /****************************************************************************/
222 
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.
SUMOVehicleClass
Definition of vehicle classes to differ between different lane usage and authority types...
SUMOVehicleShape shape
This class' shape.
Structure representing possible vehicle parameter.
bool saved
Information whether this type was already saved (needed by routers)
SUMOVTypeParameter(const std::string &vtid, const SUMOVehicleClass vc=SVC_IGNORING)
Constructor.
SUMOReal speedDev
The standard deviation for speed variations.
SUMOReal length
The physical vehicle length.
const int VTYPEPARS_BOARDING_DURATION
SUMOVehicleClass vehicleClass
The vehicle's class.
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
SUMOReal width
This class' width.
const int VTYPEPARS_OSGFILE_SET
const int VTYPEPARS_PROBABILITY_SET
const int VTYPEPARS_LANE_CHANGE_MODEL_SET
static SUMOReal getDefaultImperfection(const SUMOVehicleClass vc=SVC_IGNORING)
Returns the default driver's imperfection (sigma or epsilon in Krauss' model) for the given vehicle c...
LaneChangeModel
SUMOReal speedFactor
The factor by which the maximum speed may deviate from the allowed max speed on the street...
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.
unsigned int containerCapacity
The container capacity of the vehicle.
const int VTYPEPARS_SPEEDDEVIATION_SET
const int VTYPEPARS_LOADING_DURATION
const int VTYPEPARS_CONTAINER_CAPACITY
An upper class for objects with additional parameters.
Definition: Parameterised.h:47
bool onlyReferenced
Information whether this is a type-stub, being only referenced but not defined (needed by routers) ...
const int VTYPEPARS_SPEEDFACTOR_SET
void write(OutputDevice &dev) const
Writes the vtype.
SUMOReal maxSpeed
The vehicle type's maximum speed [m/s].
int setParameter
Information for the router which parameter were set.
static SUMOReal getDefaultDecel(const SUMOVehicleClass vc=SVC_IGNORING)
Returns the default deceleration for the given vehicle class This needs to be a function because the ...
SUMOReal impatience
The vehicle's impatience (willingness to obstruct others)
SUMOVehicleShape
Definition of vehicle classes to differ between different appearences.
bool wasSet(int what) const
Returns whether the given parameter was set.
unsigned int personCapacity
The person capacity of the vehicle.
SUMOReal defaultProbability
The probability when being added to a distribution without an explicit probability.
const int VTYPEPARS_IMGFILE_SET
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:108
std::map< SumoXMLAttr, SUMOReal > CFParams
Car-following parameter.
std::string id
The vehicle type's id.
int SUMOTime
Definition: SUMOTime.h:43
const int VTYPEPARS_PERSON_CAPACITY
const int VTYPEPARS_HEIGHT_SET
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:71
#define SUMOReal
Definition: config.h:218
static SUMOReal getDefaultAccel(const SUMOVehicleClass vc=SVC_IGNORING)
Returns the default acceleration for the given vehicle class This needs to be a function because the ...
void validateCFParameter() const
Validates stored car-following parameter.
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
SUMOReal height
This class' height.
const int VTYPEPARS_LENGTH_SET
const int VTYPEPARS_VEHICLECLASS_SET
const int VTYPEPARS_EMISSIONCLASS_SET
const int VTYPEPARS_COLOR_SET
const int VTYPEPARS_SHAPE_SET
SUMOEmissionClass emissionClass
The emission class of this vehicle.
vehicles ignoring classes
const int VTYPEPARS_IMPATIENCE_SET
SUMOReal minGap
This class' free space in front of the vehicle itself.