SUMOVehicleClass.h

Go to the documentation of this file.

/****************************************************************************/
// Definitions of SUMO vehicle classes and helper functions
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2015 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef SUMOVehicleClass_h
#define SUMOVehicleClass_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include <set>
#include <limits>
#include <utils/common/UtilExceptions.h>
#include <utils/common/StringBijection.h>
#include <utils/xml/SUMOXMLDefinitions.h>


// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;


// ===========================================================================
// enum definitions
// ===========================================================================
enum SUMOVehicleShape {
    SVS_UNKNOWN,
    SVS_PEDESTRIAN,
    SVS_BICYCLE,
    SVS_MOPED,
    SVS_MOTORCYCLE,
    SVS_PASSENGER,
    SVS_PASSENGER_SEDAN,
    SVS_PASSENGER_HATCHBACK,
    SVS_PASSENGER_WAGON,
    SVS_PASSENGER_VAN,
    SVS_DELIVERY,
    SVS_TRUCK,
    SVS_TRUCK_SEMITRAILER,
    SVS_TRUCK_1TRAILER,
    SVS_BUS,
    SVS_BUS_COACH,
    SVS_BUS_FLEXIBLE,
    SVS_BUS_TROLLEY,
    SVS_RAIL,
    SVS_RAIL_CAR,
    SVS_RAIL_CARGO,
    SVS_E_VEHICLE,
    SVS_ANT,
    SVS_SHIP
};



enum SUMOVehicleClass {
    SVC_IGNORING = 0,



    SVC_PRIVATE = 1,
    SVC_EMERGENCY = 1 << 1,
    SVC_AUTHORITY = 1 << 2,
    SVC_ARMY = 1 << 3,
    SVC_VIP = 1 << 4,




    SVC_PASSENGER = 1 << 5,
    SVC_HOV = 1 << 6,
    SVC_TAXI = 1 << 7,
    SVC_BUS = 1 << 8,
    SVC_COACH = 1 << 9,
    SVC_DELIVERY = 1 << 10,
    SVC_TRUCK = 1 << 11,
    SVC_TRAILER = 1 << 12,
    SVC_TRAM = 1 << 13,
    SVC_RAIL_URBAN = 1 << 14,
    SVC_RAIL = 1 << 15,
    SVC_RAIL_ELECTRIC = 1 << 16,

    SVC_MOTORCYCLE = 1 << 17,
    SVC_MOPED = 1 << 18,
    SVC_BICYCLE = 1 << 19,
    SVC_PEDESTRIAN = 1 << 20,
    SVC_E_VEHICLE = 1 << 21,
    SVC_SHIP = 1 << 22,
    SVC_CUSTOM1 = 1 << 23,
    SVC_CUSTOM2 = 1 << 24,

    SVC_NON_ROAD = SVC_TRAM | SVC_RAIL | SVC_RAIL_URBAN | SVC_RAIL_ELECTRIC | SVC_SHIP
};

extern const int SUMOVehicleClass_MAX;
extern StringBijection<SUMOVehicleClass> SumoVehicleClassStrings;
extern std::set<std::string> deprecatedVehicleClassesSeen;
extern StringBijection<SUMOVehicleShape> SumoVehicleShapeStrings;

/* @brief bitset where each bit declares whether a certain SVC may use this edge/lane
 */
typedef int SVCPermissions;
extern const SVCPermissions SVCAll; // everything allowed
extern const SVCPermissions SVC_UNSPECIFIED; // permissions not specified


typedef int SUMOEmissionClass;


// ===========================================================================
// method declarations
// ===========================================================================

// ---------------------------------------------------------------------------
// abstract vehicle class / purpose
// ---------------------------------------------------------------------------
extern std::string getVehicleClassNames(SVCPermissions permissions);


extern std::vector<std::string> getVehicleClassNamesList(SVCPermissions permissions);


extern SUMOVehicleClass getVehicleClassID(const std::string& name);

extern int 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);


extern SVCPermissions parseVehicleClasses(const std::vector<std::string>& allowedS);


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 isRailway(SVCPermissions permissions);

extern bool isWaterway(SVCPermissions permissions);

extern bool isForbidden(SVCPermissions permissions);

// ---------------------------------------------------------------------------
// default vehicle type parameter
// ---------------------------------------------------------------------------
extern const std::string DEFAULT_VTYPE_ID;
extern const std::string DEFAULT_PEDTYPE_ID;

extern const SUMOReal DEFAULT_VEH_PROB; // !!! does this belong here?

extern const SUMOReal DEFAULT_PEDESTRIAN_SPEED;

extern const SUMOReal DEFAULT_CONTAINER_TRANSHIP_SPEED;

#endif

/****************************************************************************/