Eclipse SUMO - Simulation of Urban MObility
SUMOVehicleClass.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-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
18 // Definitions of SUMO vehicle classes and helper functions
19 /****************************************************************************/
20 #ifndef SUMOVehicleClass_h
21 #define SUMOVehicleClass_h
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 
28 #include <string>
29 #include <set>
30 #include <limits>
31 #include <utils/common/StdDefs.h>
35 
36 
37 // ===========================================================================
38 // class declarations
39 // ===========================================================================
40 class OutputDevice;
41 class SUMOSAXAttributes;
42 
43 // ===========================================================================
44 // enum definitions
45 // ===========================================================================
72  //SVS_PASSENGER_AUTOMATED,
109 };
110 
111 
112 
136 
138 
139 
143  SVC_EMERGENCY = 1 << 1,
145  SVC_AUTHORITY = 1 << 2,
147  SVC_ARMY = 1 << 3,
149  SVC_VIP = 1 << 4,
151 
152 
154 
155  SVC_PEDESTRIAN = 1 << 5,
157 
159  SVC_PASSENGER = 1 << 6,
161  SVC_HOV = 1 << 7,
163  SVC_TAXI = 1 << 8,
165  SVC_BUS = 1 << 9,
167  SVC_COACH = 1 << 10,
169  SVC_DELIVERY = 1 << 11,
171  SVC_TRUCK = 1 << 12,
173  SVC_TRAILER = 1 << 13,
175  SVC_MOTORCYCLE = 1 << 14,
177  SVC_MOPED = 1 << 15,
179  SVC_BICYCLE = 1 << 16,
181  SVC_E_VEHICLE = 1 << 17,
182 
184  SVC_TRAM = 1 << 18,
186  SVC_RAIL_URBAN = 1 << 19,
188  SVC_RAIL = 1 << 20,
190  SVC_RAIL_ELECTRIC = 1 << 21,
192  SVC_RAIL_FAST = 1 << 22,
193 
195  SVC_SHIP = 1 << 23,
196 
198  SVC_CUSTOM1 = 1 << 24,
200  SVC_CUSTOM2 = 1 << 25,
202 
210 };
211 
214 extern std::set<std::string> deprecatedVehicleClassesSeen;
216 
218 typedef int SVCPermissions;
219 
221 extern const SVCPermissions SVCAll;
222 
224 extern const SVCPermissions SVC_UNSPECIFIED;
225 
231 typedef int SUMOEmissionClass;
232 
233 
234 // ===========================================================================
235 // method declarations
236 // ===========================================================================
237 
238 // ---------------------------------------------------------------------------
239 // abstract vehicle class / purpose
240 // ---------------------------------------------------------------------------
246 extern const std::string& getVehicleClassNames(SVCPermissions permissions, bool expand = false);
247 
252 extern const std::vector<std::string>& getVehicleClassNamesList(SVCPermissions permissions);
253 
259 extern SUMOVehicleClass getVehicleClassID(const std::string& name);
260 
265 extern int getVehicleClassCompoundID(const std::string& name);
266 
274 extern SVCPermissions parseVehicleClasses(const std::string& allowedS);
275 
277 extern bool canParseVehicleClasses(const std::string& classes);
278 
283 extern SVCPermissions parseVehicleClasses(const std::string& allowedS, const std::string& disallowedS, double networkVersion = NETWORK_VERSION);
284 
289 extern SVCPermissions parseVehicleClasses(const std::vector<std::string>& allowedS);
290 
293 
295 extern void writePermissions(OutputDevice& into, SVCPermissions permissions);
296 
298 extern void writePreferences(OutputDevice& into, SVCPermissions preferred);
299 
301 extern std::map<SVCPermissions, double> parseStopOffsets(const SUMOSAXAttributes& attrs, bool& ok);
302 
303 // ---------------------------------------------------------------------------
304 // vehicle shape class
305 // ---------------------------------------------------------------------------
310 extern std::string getVehicleShapeName(SUMOVehicleShape id);
311 
316 extern SUMOVehicleShape getVehicleShapeID(const std::string& name);
317 
319 extern bool canParseVehicleShape(const std::string& shape);
320 
325 extern bool isRailway(SVCPermissions permissions);
326 
331 extern bool isWaterway(SVCPermissions permissions);
332 
337 extern bool isForbidden(SVCPermissions permissions);
338 
343 extern bool isSidewalk(SVCPermissions permissions);
344 
349 extern bool noVehicles(SVCPermissions permissions);
350 
351 // ---------------------------------------------------------------------------
352 // default vehicle type parameter
353 // ---------------------------------------------------------------------------
354 extern const std::string DEFAULT_VTYPE_ID;
355 extern const std::string DEFAULT_PEDTYPE_ID;
356 extern const std::string DEFAULT_BIKETYPE_ID;
357 
358 extern const double DEFAULT_VEH_PROB; // !!! does this belong here?
359 
360 extern const double DEFAULT_PEDESTRIAN_SPEED;
361 
362 extern const double DEFAULT_CONTAINER_TRANSHIP_SPEED;
363 
364 #endif
365 
366 /****************************************************************************/
367 
SVC_RAIL_FAST
vehicle that is allowed to drive on high-speed rail tracks
Definition: SUMOVehicleClass.h:192
SVC_PEDESTRIAN
pedestrian
Definition: SUMOVehicleClass.h:156
SUMOVehicleClass
SUMOVehicleClass
Definition of vehicle classes to differ between different lane usage and authority types.
Definition: SUMOVehicleClass.h:133
SVC_E_VEHICLE
is an electric vehicle
Definition: SUMOVehicleClass.h:181
SVC_EMERGENCY
public emergency vehicles
Definition: SUMOVehicleClass.h:143
SVS_MOTORCYCLE
render as a motorcycle
Definition: SUMOVehicleClass.h:60
SVC_COACH
vehicle is a coach
Definition: SUMOVehicleClass.h:167
DEFAULT_PEDTYPE_ID
const std::string DEFAULT_PEDTYPE_ID
OutputDevice
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:63
getVehicleClassNamesList
const std::vector< std::string > & getVehicleClassNamesList(SVCPermissions permissions)
Returns the ids of the given classes, divided using a ' '.
Definition: SUMOVehicleClass.cpp:181
getVehicleClassID
SUMOVehicleClass getVehicleClassID(const std::string &name)
Returns the class id of the abstract class given by its name.
Definition: SUMOVehicleClass.cpp:200
NETWORK_VERSION
const double NETWORK_VERSION
version for written networks and default version for loading
Definition: StdDefs.h:65
StringBijection.h
SVS_BUS_TROLLEY
render as a trolley bus
Definition: SUMOVehicleClass.h:88
SVC_CUSTOM2
is a user-defined type
Definition: SUMOVehicleClass.h:200
writePreferences
void writePreferences(OutputDevice &into, SVCPermissions preferred)
writes allowed disallowed attributes if needed;
Definition: SUMOVehicleClass.cpp:332
getVehicleClassCompoundID
int getVehicleClassCompoundID(const std::string &name)
Returns the OR'ed id of the compound class given by its name.
Definition: SUMOVehicleClass.cpp:209
SVS_TRUCK
render as a transport vehicle
Definition: SUMOVehicleClass.h:76
SVC_BICYCLE
vehicle is a bicycle
Definition: SUMOVehicleClass.h:179
SVC_DELIVERY
vehicle is a small delivery vehicle
Definition: SUMOVehicleClass.h:169
SUMOEmissionClass
int SUMOEmissionClass
Definition: SUMOVehicleClass.h:231
SVC_NON_ROAD
classes which (normally) do not drive on normal roads
Definition: SUMOVehicleClass.h:209
getVehicleShapeName
std::string getVehicleShapeName(SUMOVehicleShape id)
Returns the class name of the shape class given by its id.
Definition: SUMOVehicleClass.cpp:358
getVehicleShapeID
SUMOVehicleShape getVehicleShapeID(const std::string &name)
Returns the class id of the shape class given by its name.
Definition: SUMOVehicleClass.cpp:342
SVC_RAIL
vehicle is a not electrified rail
Definition: SUMOVehicleClass.h:188
SVC_RAIL_URBAN
vehicle is a city rail
Definition: SUMOVehicleClass.h:186
isWaterway
bool isWaterway(SVCPermissions permissions)
Returns whether an edge with the given permission is a waterway edge.
Definition: SUMOVehicleClass.cpp:369
SVC_AUTHORITY
authorities vehicles
Definition: SUMOVehicleClass.h:145
SVS_BUS_FLEXIBLE
render as a flexible city bus
Definition: SUMOVehicleClass.h:86
SVS_PASSENGER_SEDAN
render as a sedan passenger vehicle ("Stufenheck")
Definition: SUMOVehicleClass.h:64
SVC_PRIVATE
private vehicles
Definition: SUMOVehicleClass.h:141
SVS_UNKNOWN
not defined
Definition: SUMOVehicleClass.h:52
SVS_BICYCLE
render as a bicycle
Definition: SUMOVehicleClass.h:56
DEFAULT_CONTAINER_TRANSHIP_SPEED
const double DEFAULT_CONTAINER_TRANSHIP_SPEED
noVehicles
bool noVehicles(SVCPermissions permissions)
Returns whether an edge with the given permission forbids vehicles.
Definition: SUMOVehicleClass.cpp:387
SVC_TRAM
vehicle is a light rail
Definition: SUMOVehicleClass.h:184
SVS_DELIVERY
automated car (with cruise controllers)
Definition: SUMOVehicleClass.h:74
invertPermissions
SVCPermissions invertPermissions(SVCPermissions permissions)
negate the given permissions and ensure that only relevant bits are set
Definition: SUMOVehicleClass.cpp:285
StringBijection
Definition: StringBijection.h:43
SVC_TRUCK
vehicle is a large transport vehicle
Definition: SUMOVehicleClass.h:171
SVC_CUSTOM1
is a user-defined type
Definition: SUMOVehicleClass.h:198
SVC_ARMY
army vehicles
Definition: SUMOVehicleClass.h:147
SVS_BUS
render as a bus
Definition: SUMOVehicleClass.h:82
SVCPermissions
int SVCPermissions
bitset where each bit declares whether a certain SVC may use this edge/lane
Definition: SUMOVehicleClass.h:218
SVC_RAIL_CLASSES
classes which drive on tracks
Definition: SUMOVehicleClass.h:204
DEFAULT_PEDESTRIAN_SPEED
const double DEFAULT_PEDESTRIAN_SPEED
SVC_HOV
vehicle is a HOV
Definition: SUMOVehicleClass.h:161
SUMOVehicleShape
SUMOVehicleShape
Definition of vehicle classes to differ between different appearences.
Definition: SUMOVehicleClass.h:50
DEFAULT_VTYPE_ID
const std::string DEFAULT_VTYPE_ID
SVC_PASSENGER
vehicle is a passenger car (a "normal" car)
Definition: SUMOVehicleClass.h:159
SVC_RAIL_ELECTRIC
rail vehicle that requires electrified tracks
Definition: SUMOVehicleClass.h:190
SVS_RAIL_CARGO
render as a cargo train
Definition: SUMOVehicleClass.h:94
SVS_PASSENGER_HATCHBACK
render as a hatchback passenger vehicle ("Fliessheck")
Definition: SUMOVehicleClass.h:66
canParseVehicleShape
bool canParseVehicleShape(const std::string &shape)
Checks whether the given string contains only known vehicle shape.
Definition: SUMOVehicleClass.cpp:352
SVS_MOPED
render as a moped
Definition: SUMOVehicleClass.h:58
UtilExceptions.h
SVS_POLICE
render as a police car
Definition: SUMOVehicleClass.h:106
isRailway
bool isRailway(SVCPermissions permissions)
Returns whether an edge with the given permission is a railway edge.
Definition: SUMOVehicleClass.cpp:363
parseStopOffsets
std::map< SVCPermissions, double > parseStopOffsets(const SUMOSAXAttributes &attrs, bool &ok)
Extract stopOffsets from attributes of stopOffset element.
Definition: SUMOVehicleClass.cpp:392
SVC_VIP
vip vehicles
Definition: SUMOVehicleClass.h:149
SVC_SHIP
is an arbitrary ship
Definition: SUMOVehicleClass.h:195
SVS_RAIL_CAR
render as a (city) rail without locomotive
Definition: SUMOVehicleClass.h:92
SVS_PASSENGER_VAN
render as a van
Definition: SUMOVehicleClass.h:70
SVS_PEDESTRIAN
render as a pedestrian
Definition: SUMOVehicleClass.h:54
getVehicleClassNames
const std::string & getVehicleClassNames(SVCPermissions permissions, bool expand=false)
Returns the ids of the given classes, divided using a ' '.
Definition: SUMOVehicleClass.cpp:168
canParseVehicleClasses
bool canParseVehicleClasses(const std::string &classes)
Checks whether the given string contains only known vehicle classes.
Definition: SUMOVehicleClass.cpp:251
SVC_MOPED
vehicle is a moped
Definition: SUMOVehicleClass.h:177
SVC_TAXI
vehicle is a taxi
Definition: SUMOVehicleClass.h:163
SVC_ROAD_CLASSES
classes which drive on roads
Definition: SUMOVehicleClass.h:206
parseVehicleClasses
SVCPermissions parseVehicleClasses(const std::string &allowedS)
Parses the given definition of allowed vehicle classes into the given containers Deprecated classes g...
Definition: SUMOVehicleClass.cpp:222
SVCAll
const SVCPermissions SVCAll
all VClasses are allowed
Definition: SUMOVehicleClass.cpp:146
SVS_PASSENGER
render as a passenger vehicle
Definition: SUMOVehicleClass.h:62
SVS_EMERGENCY
render as an emergency vehicle
Definition: SUMOVehicleClass.h:102
SVS_E_VEHICLE
render as a (futuristic) e-vehicle
Definition: SUMOVehicleClass.h:96
SVS_SHIP
render as a arbitrary ship
Definition: SUMOVehicleClass.h:100
SUMOVehicleClass_MAX
const SUMOVehicleClass SUMOVehicleClass_MAX
Definition: SUMOVehicleClass.cpp:144
SumoVehicleClassStrings
StringBijection< SUMOVehicleClass > SumoVehicleClassStrings
SVS_TRUCK_SEMITRAILER
render as a semi-trailer transport vehicle ("Sattelschlepper")
Definition: SUMOVehicleClass.h:78
writePermissions
void writePermissions(OutputDevice &into, SVCPermissions permissions)
writes allowed disallowed attributes if needed;
Definition: SUMOVehicleClass.cpp:309
isForbidden
bool isForbidden(SVCPermissions permissions)
Returns whether an edge with the given permission is a forbidden edge.
Definition: SUMOVehicleClass.cpp:375
SVS_FIREBRIGADE
render as a fire brigade
Definition: SUMOVehicleClass.h:104
SVC_TRAILER
vehicle is a large transport vehicle
Definition: SUMOVehicleClass.h:173
SVC_BUS
vehicle is a bus
Definition: SUMOVehicleClass.h:165
SumoVehicleShapeStrings
StringBijection< SUMOVehicleShape > SumoVehicleShapeStrings
SVS_ANT
render as a giant ant
Definition: SUMOVehicleClass.h:98
StdDefs.h
SVS_TRUCK_1TRAILER
render as a transport vehicle with one trailer
Definition: SUMOVehicleClass.h:80
SVS_PASSENGER_WAGON
render as a wagon passenger vehicle ("Combi")
Definition: SUMOVehicleClass.h:68
isSidewalk
bool isSidewalk(SVCPermissions permissions)
Returns whether an edge with the given permission is a sidewalk.
Definition: SUMOVehicleClass.cpp:381
deprecatedVehicleClassesSeen
std::set< std::string > deprecatedVehicleClassesSeen
Definition: SUMOVehicleClass.cpp:84
SVC_MOTORCYCLE
vehicle is a motorcycle
Definition: SUMOVehicleClass.h:175
SVS_BUS_COACH
render as a coach
Definition: SUMOVehicleClass.h:84
SVS_RICKSHAW
render as a rickshaw
Definition: SUMOVehicleClass.h:108
SVC_UNSPECIFIED
const SVCPermissions SVC_UNSPECIFIED
permissions not specified
Definition: SUMOVehicleClass.cpp:148
SVC_IGNORING
vehicles ignoring classes
Definition: SUMOVehicleClass.h:135
DEFAULT_BIKETYPE_ID
const std::string DEFAULT_BIKETYPE_ID
SUMOSAXAttributes
Encapsulated SAX-Attributes.
Definition: SUMOSAXAttributes.h:56
DEFAULT_VEH_PROB
const double DEFAULT_VEH_PROB
SUMOXMLDefinitions.h
SVS_RAIL
render as a rail
Definition: SUMOVehicleClass.h:90