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-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/****************************************************************************/
22// Definitions of SUMO vehicle classes and helper functions
23/****************************************************************************/
24#pragma once
25#include <config.h>
26#include <string>
27#include <set>
28#include <limits>
33
34
35// ===========================================================================
36// class declarations
37// ===========================================================================
38class OutputDevice;
40
41// ===========================================================================
42// enum definitions
43// ===========================================================================
48enum class SUMOVehicleShape {
50 UNKNOWN,
54 BICYCLE,
56 MOPED,
70 //PASSENGER_AUTOMATED,
72 TAXI,
76 TRUCK,
82 BUS,
90 RAIL,
98 ANT,
100 SHIP,
102 EMERGENCY,
106 POLICE,
108 RICKSHAW,
110 SCOOTER
111};
112
113
114
138
140
141
149 SVC_ARMY = 1 << 3,
151 SVC_VIP = 1 << 4,
153
154
156
157
159
163 SVC_HOV = 1 << 7,
165 SVC_TAXI = 1 << 8,
167 SVC_BUS = 1 << 9,
169 SVC_COACH = 1 << 10,
171 SVC_DELIVERY = 1 << 11,
173 SVC_TRUCK = 1 << 12,
175 SVC_TRAILER = 1 << 13,
177 SVC_MOTORCYCLE = 1 << 14,
179 SVC_MOPED = 1 << 15,
181 SVC_BICYCLE = 1 << 16,
183 SVC_E_VEHICLE = 1 << 17,
184
186 SVC_TRAM = 1 << 18,
188 SVC_RAIL_URBAN = 1 << 19,
190 SVC_RAIL = 1 << 20,
194 SVC_RAIL_FAST = 1 << 22,
195
197 SVC_SHIP = 1 << 23,
198
200 SVC_CUSTOM1 = 1 << 24,
202 SVC_CUSTOM2 = 1 << 25,
204
215
218extern std::set<std::string> deprecatedVehicleClassesSeen;
220
222typedef int SVCPermissions;
223
225extern const SVCPermissions SVCAll;
226
229
236
237// ===========================================================================
238// Stop Offsets
239// ===========================================================================
240
243
244public:
246 StopOffset();
247
249 StopOffset(const SUMOSAXAttributes& attrs, bool& ok);
250
252 bool isDefined() const;
253
255 void reset();
256
259
261 std::string getExceptions() const;
262
264 double getOffset() const;
265
267 void setPermissions(const SVCPermissions permissions);
268
270 void setExceptions(const std::string permissions);
271
273 void setOffset(const double offset);
274
276 bool operator==(StopOffset const& other) const;
277
279 bool operator!=(StopOffset const& other) const;
280
281private:
284
286 double myOffset;
287};
288
289// ===========================================================================
290// method declarations
291// ===========================================================================
292
293// ---------------------------------------------------------------------------
294// abstract vehicle class / purpose
295// ---------------------------------------------------------------------------
296
302extern const std::string& getVehicleClassNames(SVCPermissions permissions, bool expand = false);
303
308extern const std::vector<std::string>& getVehicleClassNamesList(SVCPermissions permissions);
309
315extern SUMOVehicleClass getVehicleClassID(const std::string& name);
316
321extern int getVehicleClassCompoundID(const std::string& name);
322
330extern SVCPermissions parseVehicleClasses(const std::string& allowedS);
331
333extern bool canParseVehicleClasses(const std::string& classes);
334
339extern SVCPermissions parseVehicleClasses(const std::string& allowedS, const std::string& disallowedS, double networkVersion = NETWORK_VERSION);
340
345extern SVCPermissions parseVehicleClasses(const std::vector<std::string>& allowedS);
346
349
351extern void writePermissions(OutputDevice& into, SVCPermissions permissions);
352
354extern void writePreferences(OutputDevice& into, SVCPermissions preferred);
355
356// ---------------------------------------------------------------------------
357// vehicle shape class
358// ---------------------------------------------------------------------------
359
364extern std::string getVehicleShapeName(SUMOVehicleShape id);
365
370extern SUMOVehicleShape getVehicleShapeID(const std::string& name);
371
373extern bool canParseVehicleShape(const std::string& shape);
374
379extern bool isRailway(SVCPermissions permissions);
380
385extern bool isTram(SVCPermissions permissions);
386
391extern bool isBikepath(SVCPermissions permissions);
392
397extern bool isWaterway(SVCPermissions permissions);
398
403extern bool isForbidden(SVCPermissions permissions);
404
409extern bool isSidewalk(SVCPermissions permissions);
410
415extern bool noVehicles(SVCPermissions permissions);
416
423
424// ---------------------------------------------------------------------------
425// default vehicle type parameter
426// ---------------------------------------------------------------------------
427extern const std::string DEFAULT_VTYPE_ID;
428extern const std::string DEFAULT_PEDTYPE_ID;
429extern const std::string DEFAULT_BIKETYPE_ID;
430extern const std::string DEFAULT_CONTAINERTYPE_ID;
431extern const std::string DEFAULT_TAXITYPE_ID;
432extern const std::set<std::string> DEFAULT_VTYPES;
433
434extern const double DEFAULT_VEH_PROB; // !!! does this belong here?
435
436extern const double DEFAULT_PEDESTRIAN_SPEED;
437
438extern const double DEFAULT_CONTAINER_TRANSHIP_SPEED;
bool canParseVehicleShape(const std::string &shape)
Checks whether the given string contains only known vehicle shape.
SUMOVehicleClass getVehicleClassID(const std::string &name)
Returns the class id of the abstract class given by its name.
const SVCPermissions SVCAll
all VClasses are allowed
SUMOVehicleClass
Definition of vehicle classes to differ between different lane usage and authority types.
@ SVC_SHIP
is an arbitrary ship
@ SVC_PRIVATE
private vehicles
@ SVC_VIP
vip vehicles
@ SVC_HOV
vehicle is a HOV
@ SVC_TRUCK
vehicle is a large transport vehicle
@ SVC_ROAD_CLASSES
classes which drive on roads
@ SVC_IGNORING
vehicles ignoring classes
@ SVC_CUSTOM2
is a user-defined type
@ SVC_RAIL
vehicle is a not electrified rail
@ SVC_RAIL_CLASSES
classes which drive on tracks
@ SVC_COACH
vehicle is a coach
@ SVC_PASSENGER
vehicle is a passenger car (a "normal" car)
@ SVC_BICYCLE
vehicle is a bicycle
@ SVC_RAIL_FAST
vehicle that is allowed to drive on high-speed rail tracks
@ SVC_TRAILER
vehicle is a large transport vehicle
@ SVC_CUSTOM1
is a user-defined type
@ SVC_ARMY
army vehicles
@ SVC_RAIL_ELECTRIC
rail vehicle that requires electrified tracks
@ SVC_NON_ROAD
classes which (normally) do not drive on normal roads
@ SVC_DELIVERY
vehicle is a small delivery vehicle
@ SVC_RAIL_URBAN
vehicle is a city rail
@ SVC_MOTORCYCLE
vehicle is a motorcycle
@ SVC_EMERGENCY
public emergency vehicles
@ SVC_MOPED
vehicle is a moped
@ SVC_AUTHORITY
authorities vehicles
@ SVC_TRAM
vehicle is a light rail
@ SVC_PUBLIC_CLASSES
public transport
@ SVC_TAXI
vehicle is a taxi
@ SVC_BUS
vehicle is a bus
@ SVC_E_VEHICLE
is an electric vehicle
@ SVC_PEDESTRIAN
pedestrian
int SUMOEmissionClass
std::set< std::string > deprecatedVehicleClassesSeen
const std::string DEFAULT_TAXITYPE_ID
const double DEFAULT_VEH_PROB
SVCPermissions invertPermissions(SVCPermissions permissions)
negate the given permissions and ensure that only relevant bits are set
bool isRailway(SVCPermissions permissions)
Returns whether an edge with the given permission is a railway edge.
const SVCPermissions SVC_UNSPECIFIED
permissions not specified
double getDefaultVehicleLength(const SUMOVehicleClass vc=SVC_IGNORING)
Returns the default vehicle length This put into a function so it can be used by NBVehicle.
bool isWaterway(SVCPermissions permissions)
Returns whether an edge with the given permission is a waterway edge.
bool isTram(SVCPermissions permissions)
Returns whether an edge with the given permission is a tram edge.
int getVehicleClassCompoundID(const std::string &name)
Returns the OR'ed id of the compound class given by its name.
StringBijection< SUMOVehicleShape > SumoVehicleShapeStrings
const std::vector< std::string > & getVehicleClassNamesList(SVCPermissions permissions)
Returns the ids of the given classes, divided using a ' '.
const std::string DEFAULT_PEDTYPE_ID
const std::set< std::string > DEFAULT_VTYPES
void writePermissions(OutputDevice &into, SVCPermissions permissions)
writes allowed disallowed attributes if needed;
SUMOVehicleShape getVehicleShapeID(const std::string &name)
Returns the class id of the shape class given by its name.
bool isForbidden(SVCPermissions permissions)
Returns whether an edge with the given permission is a forbidden edge.
StringBijection< SUMOVehicleClass > SumoVehicleClassStrings
SVCPermissions parseVehicleClasses(const std::string &allowedS)
Parses the given definition of allowed vehicle classes into the given containers Deprecated classes g...
SUMOVehicleShape
Definition of vehicle classes to differ between different appearances.
@ RICKSHAW
render as a rickshaw
@ BUS
render as a bus
@ RAIL_CARGO
render as a cargo train
@ EMERGENCY
render as an emergency vehicle
@ RAIL
render as a rail
@ PASSENGER_VAN
render as a van
@ PASSENGER
render as a passenger vehicle
@ SCOOTER
render as a scooter
@ RAIL_CAR
render as a (city) rail without locomotive
@ SHIP
render as a arbitrary ship
@ DELIVERY
render as a delivery vehicle
@ BICYCLE
render as a bicycle
@ MOTORCYCLE
render as a motorcycle
@ UNKNOWN
not defined
@ BUS_TROLLEY
render as a trolley bus
@ TAXI
automated car (with cruise controllers)
@ E_VEHICLE
render as a (futuristic) e-vehicle
@ ANT
render as a giant ant
@ TRUCK
render as a transport vehicle
@ FIREBRIGADE
render as a fire brigade
@ PASSENGER_HATCHBACK
render as a hatchback passenger vehicle ("Fliessheck")
@ MOPED
render as a moped
@ BUS_FLEXIBLE
render as a flexible city bus
@ TRUCK_1TRAILER
render as a transport vehicle with one trailer
@ PASSENGER_SEDAN
render as a sedan passenger vehicle ("Stufenheck")
@ BUS_COACH
render as a coach
@ POLICE
render as a police car
@ PASSENGER_WAGON
render as a wagon passenger vehicle ("Combi")
@ TRUCK_SEMITRAILER
render as a semi-trailer transport vehicle ("Sattelschlepper")
@ PEDESTRIAN
render as a pedestrian
const double DEFAULT_PEDESTRIAN_SPEED
bool isSidewalk(SVCPermissions permissions)
Returns whether an edge with the given permission is a sidewalk.
bool canParseVehicleClasses(const std::string &classes)
Checks whether the given string contains only known vehicle classes.
std::string getVehicleShapeName(SUMOVehicleShape id)
Returns the class name of the shape class given by its id.
void writePreferences(OutputDevice &into, SVCPermissions preferred)
writes allowed disallowed attributes if needed;
bool noVehicles(SVCPermissions permissions)
Returns whether an edge with the given permission forbids vehicles.
const std::string DEFAULT_VTYPE_ID
bool isBikepath(SVCPermissions permissions)
Returns whether an edge with the given permission is a bicycle edge.
int SVCPermissions
bitset where each bit declares whether a certain SVC may use this edge/lane
const std::string DEFAULT_CONTAINERTYPE_ID
const double DEFAULT_CONTAINER_TRANSHIP_SPEED
const SUMOVehicleClass SUMOVehicleClass_MAX
const std::string & getVehicleClassNames(SVCPermissions permissions, bool expand=false)
Returns the ids of the given classes, divided using a ' '.
const std::string DEFAULT_BIKETYPE_ID
const double NETWORK_VERSION
version for written networks and default version for loading
Definition: StdDefs.h:63
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
Encapsulated SAX-Attributes.
stop offset
void setOffset(const double offset)
set offset
StopOffset()
constructor
bool isDefined() const
check if stopOffset was defined
void reset()
reset stopOffset
SVCPermissions getPermissions() const
get permissions
void setExceptions(const std::string permissions)
set exceptions (used in NETEDIT)
SVCPermissions myPermissions
permissions (allowed)
double myOffset
offset
std::string getExceptions() const
get exceptions (used in NETEDIT)
void setPermissions(const SVCPermissions permissions)
update permissions
bool operator==(StopOffset const &other) const
comparator
bool operator!=(StopOffset const &other) const
comparator
double getOffset() const
get offset