SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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-sim.org/
12 // Copyright (C) 2001-2014 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>
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 VTYPEPARS_LENGTH_SET = 1;
54 const int VTYPEPARS_MINGAP_SET = 2;
55 const int VTYPEPARS_MAXSPEED_SET = 2 << 2;
56 const int VTYPEPARS_PROBABILITY_SET = 2 << 3;
57 const int VTYPEPARS_SPEEDFACTOR_SET = 2 << 4;
58 const int VTYPEPARS_SPEEDDEVIATION_SET = 2 << 5;
59 const int VTYPEPARS_EMISSIONCLASS_SET = 2 << 6;
60 const int VTYPEPARS_COLOR_SET = 2 << 7;
61 const int VTYPEPARS_VEHICLECLASS_SET = 2 << 8;
62 const int VTYPEPARS_WIDTH_SET = 2 << 9;
63 const int VTYPEPARS_HEIGHT_SET = 2 << 10;
64 const int VTYPEPARS_SHAPE_SET = 2 << 11;
65 const int VTYPEPARS_OSGFILE_SET = 2 << 12;
66 const int VTYPEPARS_IMGFILE_SET = 2 << 13;
67 const int VTYPEPARS_IMPATIENCE_SET = 2 << 14;
68 const int VTYPEPARS_LANE_CHANGE_MODEL_SET = 2 << 15;
69 
70 
71 // ===========================================================================
72 // struct definitions
73 // ===========================================================================
79 public:
84  SUMOVTypeParameter(const std::string& vtid, const SUMOVehicleClass vc = SVC_IGNORING);
85 
86 
91  bool wasSet(int what) const {
92  return (setParameter & what) != 0;
93  }
94 
95 
101  void write(OutputDevice& dev) const;
102 
105  void validateCFParameter() const;
106 
107 
113  SUMOReal get(const SumoXMLAttr attr, const SUMOReal defaultValue) const;
114 
115 
117  std::string id;
118 
139 
140 
143 
146 
149 
152 
154  std::string osgFile;
155 
157  std::string imgFile;
159 
160 
163 
165  typedef std::map<SumoXMLAttr, SUMOReal> CFParams;
167 
170 
173 
174 
176  mutable bool saved;
177 
179  mutable bool onlyReferenced;
180 
187 
194 
201 
203  static const SUMOVTypeParameter& getDefault();
204 
205 };
206 
207 #endif
208 
209 /****************************************************************************/
210 
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.
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...
std::string osgFile
3D model file for this class
std::string imgFile
Image file for this class.
const int VTYPEPARS_SPEEDDEVIATION_SET
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.
SUMOReal defaultProbability
The probability when being added to a distribution without an explicit probability.
const int VTYPEPARS_IMGFILE_SET
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.
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:215
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.