SUMOVehicleClass.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Definitions of SUMO vehicle classes and helper functions
/****************************************************************************/
#pragma once
#include <config.h>
#include <string>
#include <set>
#include <limits>
#include <utils/common/StdDefs.h>
#include <utils/common/UtilExceptions.h>
#include <utils/common/StringBijection.h>
#include <utils/xml/SUMOXMLDefinitions.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;
class SUMOSAXAttributes;
 
// ===========================================================================
// enum definitions
// ===========================================================================
enum class SUMOVehicleShape {
    UNKNOWN,
    PEDESTRIAN,
    BICYCLE,
    MOPED,
    MOTORCYCLE,
    PASSENGER,
    PASSENGER_SEDAN,
    PASSENGER_HATCHBACK,
    PASSENGER_WAGON,
    PASSENGER_VAN,
    //PASSENGER_AUTOMATED,
    TAXI,
    DELIVERY,
    TRUCK,
    TRUCK_SEMITRAILER,
    TRUCK_1TRAILER,
    BUS,
    BUS_COACH,
    BUS_FLEXIBLE,
    BUS_TROLLEY,
    RAIL,
    RAIL_CAR,
    RAIL_CARGO,
    E_VEHICLE,
    ANT,
    SHIP,
    EMERGENCY,
    FIREBRIGADE,
    POLICE,
    RICKSHAW,
    SCOOTER,
    AIRCRAFT
};
 
 
 
enum SUMOVehicleClass : int64_t {
    SVC_IGNORING = 0,
 
 
 
    SVC_PRIVATE = 1,
    SVC_EMERGENCY = 1 << 1,
    SVC_AUTHORITY = 1 << 2,
    SVC_ARMY = 1 << 3,
    SVC_VIP = 1 << 4,
 
 
 
    SVC_PEDESTRIAN = 1 << 5,
 
    SVC_PASSENGER = 1 << 6,
    SVC_HOV = 1 << 7,
    SVC_TAXI = 1 << 8,
    SVC_BUS = 1 << 9,
    SVC_COACH = 1 << 10,
    SVC_DELIVERY = 1 << 11,
    SVC_TRUCK = 1 << 12,
    SVC_TRAILER = 1 << 13,
    SVC_MOTORCYCLE = 1 << 14,
    SVC_MOPED = 1 << 15,
    SVC_BICYCLE = 1 << 16,
    SVC_E_VEHICLE = 1 << 17,
 
    SVC_TRAM = 1 << 18,
    SVC_RAIL_URBAN = 1 << 19,
    SVC_RAIL = 1 << 20,
    SVC_RAIL_ELECTRIC = 1 << 21,
    SVC_RAIL_FAST = 1 << 22,
 
    SVC_SHIP = 1 << 23,
 
    SVC_CONTAINER = 1 << 24,
    SVC_CABLE_CAR = 1 << 25,
    SVC_SUBWAY = 1 << 26,
    SVC_AIRCRAFT = 1 << 27,
    SVC_WHEELCHAIR = 1 << 28,
    SVC_SCOOTER = 1 << 29,
    SVC_DRONE = 1 << 30,
 
    SVC_CUSTOM1 = (long long int)1 << 31,
    SVC_CUSTOM2 = (long long int)1 << 32,
 
    SVC_RAIL_CLASSES = SVC_RAIL_ELECTRIC | SVC_RAIL_FAST | SVC_RAIL | SVC_RAIL_URBAN | SVC_TRAM | SVC_SUBWAY | SVC_CABLE_CAR,
    SVC_PUBLIC_CLASSES = SVC_BUS | SVC_RAIL_CLASSES | SVC_CABLE_CAR | SVC_AIRCRAFT,
    SVC_ROAD_CLASSES = (SVC_PEDESTRIAN | SVC_PASSENGER | SVC_HOV | SVC_TAXI | SVC_BUS | SVC_COACH | SVC_DELIVERY
                        | SVC_TRUCK | SVC_TRAILER | SVC_MOTORCYCLE | SVC_MOPED | SVC_BICYCLE | SVC_E_VEHICLE
                        | SVC_WHEELCHAIR | SVC_SCOOTER),
    SVC_NON_ROAD = SVC_RAIL_CLASSES | SVC_SHIP | SVC_AIRCRAFT | SVC_DRONE | SVC_CONTAINER,
    SVC_WEAK = SVC_PEDESTRIAN | SVC_WHEELCHAIR | SVC_BICYCLE | SVC_SCOOTER
};
 
extern const SUMOVehicleClass SUMOVehicleClass_MAX;
extern StringBijection<SUMOVehicleClass> SumoVehicleClassStrings;
extern std::set<std::string> deprecatedVehicleClassesSeen;
extern StringBijection<SUMOVehicleShape> SumoVehicleShapeStrings;
 
typedef long long int SVCPermissions;
 
extern const SVCPermissions SVCAll;
 
extern const SVCPermissions SVC_UNSPECIFIED;
 
typedef int SUMOEmissionClass;
 
extern const SUMOEmissionClass EMISSION_CLASS_UNSPECIFIED;
 
// ===========================================================================
// Stop Offsets
// ===========================================================================
 
class StopOffset {
 
public:
    StopOffset();
 
    StopOffset(const SUMOSAXAttributes& attrs, bool& ok);
 
    bool isDefined() const;
 
    void reset();
 
    SVCPermissions getPermissions() const;
 
    std::string getExceptions() const;
 
    double getOffset() const;
 
    void setPermissions(const SVCPermissions permissions);
 
    void setExceptions(const std::string permissions);
 
    void setOffset(const double offset);
 
    bool operator==(StopOffset const& other) const;
 
    bool operator!=(StopOffset const& other) const;
 
private:
    SVCPermissions myPermissions;
 
    double myOffset;
};
 
// ===========================================================================
// method declarations
// ===========================================================================
 
// ---------------------------------------------------------------------------
// abstract vehicle class / purpose
// ---------------------------------------------------------------------------
 
extern const std::string& getVehicleClassNames(SVCPermissions permissions, bool expand = false);
 
extern const std::vector<std::string>& getVehicleClassNamesList(SVCPermissions permissions);
 
extern SUMOVehicleClass getVehicleClassID(const std::string& name);
 
extern SVCPermissions getVehicleClassCompoundID(const std::string& name);
 
extern SVCPermissions parseVehicleClasses(const std::string& allowedS);
 
extern bool canParseVehicleClasses(const std::string& classes);
 
extern SVCPermissions parseVehicleClasses(const std::string& allowedS, const std::string& disallowedS, const MMVersion& networkVersion = NETWORK_VERSION);
 
extern SVCPermissions parseVehicleClasses(const std::vector<std::string>& allowedS);
 
extern SVCPermissions extraDisallowed(SVCPermissions disallowed, const MMVersion& networkVersion);
 
extern SVCPermissions invertPermissions(SVCPermissions permissions);
 
extern void writePermissions(OutputDevice& into, SVCPermissions permissions);
 
extern void writePreferences(OutputDevice& into, SVCPermissions preferred);
 
// ---------------------------------------------------------------------------
// vehicle shape class
// ---------------------------------------------------------------------------
 
extern std::string getVehicleShapeName(SUMOVehicleShape id);
 
extern SUMOVehicleShape getVehicleShapeID(const std::string& name);
 
extern bool canParseVehicleShape(const std::string& shape);
 
extern bool isRailway(SVCPermissions permissions);
 
extern bool isTram(SVCPermissions permissions);
 
extern bool isBikepath(SVCPermissions permissions);
 
extern bool isWaterway(SVCPermissions permissions);
 
extern bool isAirway(SVCPermissions permissions);
 
extern bool isForbidden(SVCPermissions permissions);
 
extern bool isSidewalk(SVCPermissions permissions);
 
extern bool isForWeakModes(SVCPermissions permissions);
 
extern bool noVehicles(SVCPermissions permissions);
 
extern double getDefaultVehicleLength(const SUMOVehicleClass vc = SVC_IGNORING);
 
// ---------------------------------------------------------------------------
// default vehicle type parameter
// ---------------------------------------------------------------------------
extern const std::string DEFAULT_VTYPE_ID;
extern const std::string DEFAULT_PEDTYPE_ID;
extern const std::string DEFAULT_BIKETYPE_ID;
extern const std::string DEFAULT_CONTAINERTYPE_ID;
extern const std::string DEFAULT_TAXITYPE_ID;
extern const std::string DEFAULT_RAILTYPE_ID;
extern const std::set<std::string> DEFAULT_VTYPES;
 
extern const double DEFAULT_VEH_PROB; // !!! does this belong here?
 
extern const double DEFAULT_PEDESTRIAN_SPEED;
extern const double DEFAULT_BICYCLE_SPEED;
 
extern const double DEFAULT_CONTAINER_TRANSHIP_SPEED;