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.sourceforge.net/
// Copyright (C) 2001-2011 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program 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 2 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 <utils/common/UtilExceptions.h>
#include <utils/common/StringBijection.h>
#include <utils/xml/SUMOXMLDefinitions.h>

// ===========================================================================
// enum definitions
// ===========================================================================
enum SUMOVehicleShape {
    SVS_UNKNOWN,
    SVS_PEDESTRIAN,
    SVS_BICYCLE,
    SVS_MOTORCYCLE,
    SVS_PASSENGER,
    SVS_PASSENGER_SEDAN,
    SVS_PASSENGER_HATCHBACK,
    SVS_PASSENGER_WAGON,
    SVS_PASSENGER_VAN,
    SVS_DELIVERY,
    SVS_TRANSPORT,
    SVS_TRANSPORT_SEMITRAILER,
    SVS_TRANSPORT_1TRAILER,
    SVS_BUS,
    SVS_BUS_CITY,
    SVS_BUS_CITY_FLEXIBLE,
    SVS_BUS_OVERLAND,
    SVS_BUS_TROLLEY,
    SVS_RAIL,
    SVS_RAIL_LIGHT,
    SVS_RAIL_CITY,
    SVS_RAIL_SLOW,
    SVS_RAIL_FAST,
    SVS_RAIL_CARGO,
    SVS_E_VEHICLE,
    SVS_ANT
};



enum SUMOVehicleClass {
    SVC_UNKNOWN = 0,



    SVC_PRIVATE = 1,
    SVC_PUBLIC_TRANSPORT = 2,
    SVC_PUBLIC_EMERGENCY = 4,
    SVC_PUBLIC_AUTHORITY = 8,
    SVC_PUBLIC_ARMY = 16,
    SVC_VIP = 32,
    SVC_IGNORING = 64,




    SVC_PASSENGER = 256,
    SVC_HOV = 512,
    SVC_TAXI = 1024,
    SVC_BUS = 2048,
    SVC_DELIVERY = 4096,
    SVC_TRANSPORT = 8192,
    SVC_LIGHTRAIL = 16384,
    SVC_CITYRAIL = 32768,
    SVC_RAIL_SLOW = 65536,
    SVC_RAIL_FAST = 131072,

    SVC_MOTORCYCLE = 262144,
    SVC_BICYCLE = 524288,
    SVC_PEDESTRIAN = 1048576

};

extern StringBijection<SUMOVehicleClass> SumoVehicleClassStrings;
extern StringBijection<SUMOVehicleShape> SumoVehicleShapeStrings;

enum SUMOEmissionClass {
    SVE_UNKNOWN = -1,
    // heavy duty vehicles; 3 clusters
    SVE_HDV_3_1 = 0,
    SVE_HDV_3_2,
    SVE_HDV_3_3,
    // heavy duty vehicles; 6 clusters
    SVE_HDV_6_1,
    SVE_HDV_6_2,
    SVE_HDV_6_3,
    SVE_HDV_6_4,
    SVE_HDV_6_5,
    SVE_HDV_6_6,
    // heavy duty vehicles; 12 clusters
    SVE_HDV_12_1,
    SVE_HDV_12_2,
    SVE_HDV_12_3,
    SVE_HDV_12_4,
    SVE_HDV_12_5,
    SVE_HDV_12_6,
    SVE_HDV_12_7,
    SVE_HDV_12_8,
    SVE_HDV_12_9,
    SVE_HDV_12_10,
    SVE_HDV_12_11,
    SVE_HDV_12_12,
    // passenger & light duty vehicles; 7 clusters
    SVE_P_LDV_7_1,
    SVE_P_LDV_7_2,
    SVE_P_LDV_7_3,
    SVE_P_LDV_7_4,
    SVE_P_LDV_7_5,
    SVE_P_LDV_7_6,
    SVE_P_LDV_7_7,
    // passenger & light duty vehicles; 14 clusters
    SVE_P_LDV_14_1,
    SVE_P_LDV_14_2,
    SVE_P_LDV_14_3,
    SVE_P_LDV_14_4,
    SVE_P_LDV_14_5,
    SVE_P_LDV_14_6,
    SVE_P_LDV_14_7,
    SVE_P_LDV_14_8,
    SVE_P_LDV_14_9,
    SVE_P_LDV_14_10,
    SVE_P_LDV_14_11,
    SVE_P_LDV_14_12,
    SVE_P_LDV_14_13,
    SVE_P_LDV_14_14,
    // no emissions
    SVE_ZERO_EMISSIONS
};


typedef std::set<SUMOVehicleClass> SUMOVehicleClasses;


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

// ---------------------------------------------------------------------------
// abstract vehicle class / purpose
// ---------------------------------------------------------------------------
/* @brief SUMOVehicleClass is meant to be OR'ed to combine information about vehicle
 * ownership and vehicle "size" into one int.
 * These OR'ed values cannot be translated directly into strings with toString().
 * The names of all base values are concatenated with '|' as a separator.
 */
extern std::string getVehicleClassCompoundName(int id);


extern std::string getVehicleClassNames(const SUMOVehicleClasses& ids);


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

extern int getVehicleClassCompoundID(const std::string& name);

extern void parseVehicleClasses(const std::string& classNames,
                                SUMOVehicleClasses& container);

extern void parseVehicleClasses(const std::string& allowedS,
                                const std::string& disallowedS,
                                SUMOVehicleClasses& allowed,
                                SUMOVehicleClasses& disallowed);


extern void parseVehicleClasses(const std::vector<std::string> &classesS,
                                SUMOVehicleClasses& classes);


// ---------------------------------------------------------------------------
// vehicle shape class
// ---------------------------------------------------------------------------
extern std::string getVehicleShapeName(SUMOVehicleShape id);


extern SUMOVehicleShape getVehicleShapeID(const std::string& name);


// ---------------------------------------------------------------------------
// emission class
// ---------------------------------------------------------------------------
extern std::string getVehicleEmissionTypeName(SUMOEmissionClass id);


extern SUMOEmissionClass getVehicleEmissionTypeID(const std::string& name) throw(ProcessError);


// ---------------------------------------------------------------------------
// default vehicle type parameter
// ---------------------------------------------------------------------------
extern const std::string DEFAULT_VTYPE_ID;
extern const SUMOReal DEFAULT_VEH_MAXSPEED;
extern const SUMOReal DEFAULT_VEH_ACCEL;
extern const SUMOReal DEFAULT_VEH_DECEL;
extern const SUMOReal DEFAULT_VEH_SIGMA;
extern const SUMOReal DEFAULT_VEH_LENGTH;
extern const SUMOReal DEFAULT_VEH_MINGAP;
extern const SUMOReal DEFAULT_VEH_TAU;
extern const SUMOVehicleClass DEFAULT_VEH_CLASS;
extern const SUMOReal DEFAULT_VEH_PROB;
extern const SUMOReal DEFAULT_VEH_SPEEDFACTOR;
extern const SUMOReal DEFAULT_VEH_SPEEDDEV;
extern const SUMOReal DEFAULT_VEH_GUIWIDTH;
extern const SumoXMLTag DEFAULT_VEH_FOLLOW_MODEL;
extern const std::string DEFAULT_VEH_LANE_CHANGE_MODEL;
extern const SUMOVehicleShape DEFAULT_VEH_SHAPE;

#endif

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