SUMOXMLDefinitions.h

Go to the documentation of this file.

/****************************************************************************/
// Definitions of elements and attributes known by SUMO
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2012 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 SUMOXMLDefinitions_h
#define SUMOXMLDefinitions_h


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

#include <utils/common/StringBijection.h>

// ===========================================================================
// definitions
// ===========================================================================
enum SumoXMLTag {
    SUMO_TAG_NOTHING,
    SUMO_TAG_EDGE,
    SUMO_TAG_LANE,
    SUMO_TAG_POI,
    SUMO_TAG_POLY,
    SUMO_TAG_JUNCTION,
#ifdef _MESSAGES

    SUMO_TAG_MSG_EMITTER,
#endif

    SUMO_TAG_E1DETECTOR__DEPRECATED,
    SUMO_TAG_E1DETECTOR,
    SUMO_TAG_INDUCTION_LOOP,
    SUMO_TAG_E2DETECTOR__DEPRECATED,
    SUMO_TAG_E2DETECTOR,
    SUMO_TAG_LANE_AREA_DETECTOR,
    SUMO_TAG_E3DETECTOR__DEPRECATED,
    SUMO_TAG_E3DETECTOR,
    SUMO_TAG_ENTRY_EXIT_DETECTOR,
    SUMO_TAG_MEANDATA_EDGE__DEPRECATED,
    SUMO_TAG_MEANDATA_EDGE,
    SUMO_TAG_MEANDATA_LANE__DEPRECATED,
    SUMO_TAG_MEANDATA_LANE,
    SUMO_TAG_DET_ENTRY__DEPRECATED,
    SUMO_TAG_DET_ENTRY,
    SUMO_TAG_DET_EXIT__DEPRECATED,
    SUMO_TAG_DET_EXIT,
    SUMO_TAG_EDGEFOLLOWDETECTOR,
    SUMO_TAG_INSTANT_INDUCTION_LOOP,
    SUMO_TAG_VSS,
    SUMO_TAG_CALIBRATOR,
    SUMO_TAG_REROUTER,
    SUMO_TAG_BUS_STOP,
    SUMO_TAG_VTYPEPROBE__DEPRECATED,
    SUMO_TAG_VTYPEPROBE,
    SUMO_TAG_ROUTEPROBE__DEPRECATED,
    SUMO_TAG_ROUTEPROBE,
    SUMO_TAG_VEHICLE,
    SUMO_TAG_VTYPE__DEPRECATED,
    SUMO_TAG_VTYPE,
    SUMO_TAG_ROUTE,
    SUMO_TAG_SUCC,
    SUMO_TAG_SUCCLANE,
    SUMO_TAG_ROWLOGIC__DEPRECATED,
    SUMO_TAG_LOGICITEM,
    SUMO_TAG_REQUEST,
    SUMO_TAG_SOURCE,
    SUMO_TAG_DISTRICT__DEPRECATED,
    SUMO_TAG_TAZ,
    SUMO_TAG_DSOURCE__DEPRECATED,
    SUMO_TAG_TAZSOURCE,
    SUMO_TAG_DSINK__DEPRECATED,
    SUMO_TAG_TAZSINK,
    SUMO_TAG_TLLOGIC__DEPRECATED,
    SUMO_TAG_TLLOGIC,
    SUMO_TAG_PHASE,
    SUMO_TAG_TRIP__DEPRECATED,
    SUMO_TAG_TRIP,
    SUMO_TAG_FLOW,
    SUMO_TAG_STEP,
    SUMO_TAG_INTERVAL,
    SUMO_TAG_TIMEDEVENT__DEPRECATED,
    SUMO_TAG_TIMEDEVENT,
    SUMO_TAG_FROMEDGE__DEPRECATED,
    SUMO_TAG_FROMEDGE,
    SUMO_TAG_TOEDGE__DEPRECATED,
    SUMO_TAG_TOEDGE,
    SUMO_TAG_SINK,
    SUMO_TAG_PARAM,
    SUMO_TAG_WAUT,
    SUMO_TAG_WAUT_SWITCH,
    SUMO_TAG_WAUT_JUNCTION,
    SUMO_TAG_RESET,
    SUMO_TAG_DELETE,
    SUMO_TAG_STOP,
    SUMO_TAG_DEST_PROB_REROUTE__DEPRECATED,
    SUMO_TAG_DEST_PROB_REROUTE,
    SUMO_TAG_CLOSING_REROUTE__DEPRECATED,
    SUMO_TAG_CLOSING_REROUTE,
    SUMO_TAG_ROUTE_PROB_REROUTE__DEPRECATED,
    SUMO_TAG_ROUTE_PROB_REROUTE,
    SUMO_TAG_POLYTYPE__DEPRECATED,
    SUMO_TAG_POLYTYPE,
    SUMO_TAG_CONNECTION,
    SUMO_TAG_PROHIBITION,
    SUMO_TAG_SPLIT,
    SUMO_TAG_NODE,
    SUMO_TAG_TYPE,
    SUMO_TAG_DETECTOR_DEFINITION__DEPRECATED,
    SUMO_TAG_DETECTOR_DEFINITION,
    SUMO_TAG_ROUTE_DISTRIBUTION,
    SUMO_TAG_VTYPE_DISTRIBUTION__DEPRECATED,
    SUMO_TAG_VTYPE_DISTRIBUTION,
    SUMO_TAG_VAPORIZER,
    SUMO_TAG_ROUNDABOUT,
    SUMO_TAG_JOIN,
    SUMO_TAG_JOINEXCLUDE,

    SUMO_TAG_WAY,
    SUMO_TAG_ND,
    SUMO_TAG_TAG,

    SUMO_TAG_VIEWSETTINGS_DECAL,
    SUMO_TAG_VIEWSETTINGS_SCHEME,
    SUMO_TAG_VIEWSETTINGS_OPENGL,
    SUMO_TAG_VIEWSETTINGS_BACKGROUND,
    SUMO_TAG_VIEWSETTINGS_EDGES,
    SUMO_TAG_VIEWSETTINGS_EDGE_COLOR_ITEM,
    SUMO_TAG_VIEWSETTINGS_VEHICLES,
    SUMO_TAG_VIEWSETTINGS_VEHICLE_COLOR_ITEM,
    SUMO_TAG_VIEWSETTINGS_JUNCTIONS,
    SUMO_TAG_VIEWSETTINGS_ADDITIONALS,
    SUMO_TAG_VIEWSETTINGS_POIS,
    SUMO_TAG_VIEWSETTINGS_LEGEND,
    SUMO_TAG_INCLUDE,
    SUMO_TAG_DELAY,
    SUMO_TAG_VIEWPORT,
    SUMO_TAG_SNAPSHOT,
    SUMO_TAG_LOCATION,
    SUMO_TAG_COLORSCHEME,
    SUMO_TAG_ENTRY,

    SUMO_TAG_CF_KRAUSS,
    SUMO_TAG_CF_KRAUSS_ORIG1,
    SUMO_TAG_CF_IDM,
    SUMO_TAG_CF_IDMM,
    SUMO_TAG_CF_PWAGNER2009,
    SUMO_TAG_CF_BKERNER,
    SUMO_TAG_CF_WIEDEMANN,

    SUMO_TAG_PERSON,
    SUMO_TAG_RIDE,
    SUMO_TAG_WALK,

    AGEN_TAG_GENERAL,
    /* streets object */
    AGEN_TAG_STREET,

    /* workingHours object */
    AGEN_TAG_WORKHOURS,
    AGEN_TAG_OPENING,
    AGEN_TAG_CLOSING,

    /* school object */
    AGEN_TAG_SCHOOLS,
    AGEN_TAG_SCHOOL,

    /* busStation and bus objects */
    AGEN_TAG_BUSSTATION,
    AGEN_TAG_BUSLINE,
    AGEN_TAG_STATIONS,
    AGEN_TAG_REV_STATIONS,
    AGEN_TAG_STATION,
    AGEN_TAG_FREQUENCY,

    /* population and children accompaniment brackets */
    AGEN_TAG_POPULATION,
    AGEN_TAG_BRACKET,
    //AGEN_TAG_CHILD_ACOMP,

    /* city entrances */
    AGEN_TAG_CITYGATES,
    AGEN_TAG_ENTRANCE,

    /* parameters */
    AGEN_TAG_PARAM

};


enum SumoXMLAttr {
    SUMO_ATTR_NOTHING,
    /* common attributes */
    SUMO_ATTR_ID,
    SUMO_ATTR_REFID__DEPRECATED,
    SUMO_ATTR_REFID,
    SUMO_ATTR_NAME,
    SUMO_ATTR_TYPE,
    SUMO_ATTR_PRIORITY,
    SUMO_ATTR_NOLANES__DEPRECATED,
    SUMO_ATTR_NUMLANES,
    SUMO_ATTR_SPEED,
    SUMO_ATTR_ONEWAY,
    SUMO_ATTR_WIDTH,
    SUMO_ATTR_REMOVE,
    /* edge attributes */
    SUMO_ATTR_LENGTH,
    SUMO_ATTR_FROMNODE,
    SUMO_ATTR_TONODE,
    SUMO_ATTR_XFROM,
    SUMO_ATTR_YFROM,
    SUMO_ATTR_XTO,
    SUMO_ATTR_YTO,
    /* node attributes */
    SUMO_ATTR_X,
    SUMO_ATTR_Y,
    SUMO_ATTR_Z,
    /* sumo-junction attributes */
    SUMO_ATTR_KEY,
    SUMO_ATTR_REQUESTSIZE,
    SUMO_ATTR_REQUEST,
    SUMO_ATTR_RESPONSE,
    SUMO_ATTR_PROGRAMID,
    SUMO_ATTR_OFFSET,
    SUMO_ATTR_ENDOFFSET,
    SUMO_ATTR_INCLANES,
    SUMO_ATTR_INTLANES,
    SUMO_ATTR_WEIGHT,
    SUMO_ATTR_EDGE,
    SUMO_ATTR_EDGES,
    /* vehicle attributes */
    SUMO_ATTR_DEPART,
    SUMO_ATTR_DEPARTLANE__DEPRECATED,
    SUMO_ATTR_DEPARTLANE,
    SUMO_ATTR_DEPARTPOS__DEPRECATED,
    SUMO_ATTR_DEPARTPOS,
    SUMO_ATTR_DEPARTSPEED__DEPRECATED,
    SUMO_ATTR_DEPARTSPEED,
    SUMO_ATTR_ARRIVALLANE__DEPRECATED,
    SUMO_ATTR_ARRIVALLANE,
    SUMO_ATTR_ARRIVALPOS__DEPRECATED,
    SUMO_ATTR_ARRIVALPOS,
    SUMO_ATTR_ARRIVALSPEED__DEPRECATED,
    SUMO_ATTR_ARRIVALSPEED,
    SUMO_ATTR_ROUTE,
    SUMO_ATTR_MAXSPEED__DEPRECATED,
    SUMO_ATTR_MAXSPEED,
    SUMO_ATTR_ACCEL,
    SUMO_ATTR_DECEL,
    SUMO_ATTR_VCLASS__DEPRECATED,
    SUMO_ATTR_VCLASS,
    SUMO_ATTR_REPNUMBER,
    SUMO_ATTR_SPEEDFACTOR,
    SUMO_ATTR_SPEEDDEV,
    SUMO_ATTR_LANE_CHANGE_MODEL,
    SUMO_ATTR_MINGAP,
    /* Car following model attributes */
    SUMO_ATTR_SIGMA,    // used by: Krauss
    SUMO_ATTR_TAU,      // Krauss
    /* route alternatives / distribution attributes */
    SUMO_ATTR_LAST,
    SUMO_ATTR_COST,
    SUMO_ATTR_PROB,
    SUMO_ATTR_ROUTES,
    SUMO_ATTR_VTYPES__DEPRECATED,
    SUMO_ATTR_VTYPES,
    /* trip definition attributes */
    SUMO_ATTR_LANE,
    SUMO_ATTR_LANES,
    SUMO_ATTR_FROM,
    SUMO_ATTR_TO,
    SUMO_ATTR_PERIOD,
    SUMO_ATTR_FROM_TAZ__DEPRECATED,
    SUMO_ATTR_FROM_TAZ,
    SUMO_ATTR_TO_TAZ__DEPRECATED,
    SUMO_ATTR_TO_TAZ,
    SUMO_ATTR_REROUTE,
    /* source definitions */
    SUMO_ATTR_FUNCTION,
    SUMO_ATTR_POSITION,
    SUMO_ATTR_FREQUENCY,
    SUMO_ATTR_STYLE,
    SUMO_ATTR_FILE,
    SUMO_ATTR_JUNCTION,
    SUMO_ATTR_NO__DEPRECATED,
    SUMO_ATTR_NUMBER,
    SUMO_ATTR_DURATION,
    SUMO_ATTR_UNTIL,
    SUMO_ATTR_TIME,
    SUMO_ATTR_BEGIN,
    SUMO_ATTR_END,
    SUMO_ATTR_TLID,
    SUMO_ATTR_TLLINKNO__DEPRECATED,
    SUMO_ATTR_TLLINKINDEX,
    SUMO_ATTR_SHAPE,
    SUMO_ATTR_SPREADFUNC__DEPRECATED,
    SUMO_ATTR_SPREADTYPE,
    SUMO_ATTR_COLOR,
    SUMO_ATTR_DIR,
    SUMO_ATTR_STATE,
    SUMO_ATTR_LAYER,
    SUMO_ATTR_FILL,
    SUMO_ATTR_PREFIX,
    SUMO_ATTR_DISCARD,

    SUMO_ATTR_FROM_LANE,
    SUMO_ATTR_TO_LANE,
    SUMO_ATTR_DEST,
    SUMO_ATTR_SOURCE,
    SUMO_ATTR_VIA,
    SUMO_ATTR_NODES,
#ifdef _MESSAGES
    // Attributes for message emitter
    SUMO_ATTR_EVENTS,
    SUMO_ATTR_REVERSE,
    SUMO_ATTR_TABLE,
    SUMO_ATTR_XY,
    SUMO_ATTR_STEP,
    // Attribute for detectors
    SUMO_ATTR_MSG,
#endif
    // Attributes for actuated traffic lights:
    SUMO_ATTR_MINDURATION__DEPRECATED,
    SUMO_ATTR_MINDURATION,
    SUMO_ATTR_MAXDURATION__DEPRECATED,
    SUMO_ATTR_MAXDURATION,
    // Attributes for junction-internal lanes
    SUMO_ATTR_FOES,
    // Attributes for detectors
    SUMO_ATTR_CONT,
    SUMO_ATTR_HALTING_TIME_THRESHOLD__DEPRECATED,
    SUMO_ATTR_HALTING_TIME_THRESHOLD,
    SUMO_ATTR_HALTING_SPEED_THRESHOLD__DEPRECATED,
    SUMO_ATTR_HALTING_SPEED_THRESHOLD,
    SUMO_ATTR_JAM_DIST_THRESHOLD__DEPRECATED,
    SUMO_ATTR_JAM_DIST_THRESHOLD,

    SUMO_ATTR_WAUT_ID,
    SUMO_ATTR_JUNCTION_ID,
    SUMO_ATTR_PROCEDURE,
    SUMO_ATTR_SYNCHRON,
    SUMO_ATTR_REF_TIME,
    SUMO_ATTR_START_PROG,

    SUMO_ATTR_OFF,
    SUMO_ATTR_FRIENDLY_POS__DEPRECATED,
    SUMO_ATTR_FRIENDLY_POS,
    SUMO_ATTR_SPLIT_VTYPE,
    SUMO_ATTR_UNCONTROLLED,
    SUMO_ATTR_PASS,
    SUMO_ATTR_BUS_STOP__DEPRECATED,
    SUMO_ATTR_BUS_STOP,
    SUMO_ATTR_LINE,
    SUMO_ATTR_LINES,
    SUMO_ATTR_VALUE,
    SUMO_ATTR_PROHIBITOR,
    SUMO_ATTR_PROHIBITED,
    SUMO_ATTR_ALLOW,
    SUMO_ATTR_DISALLOW,
    SUMO_ATTR_PREFER,
    SUMO_ATTR_CONTROLLED_INNER__DEPRECATED,
    SUMO_ATTR_CONTROLLED_INNER,
    SUMO_ATTR_VEHSPERHOUR,
    SUMO_ATTR_OUTPUT,
    SUMO_ATTR_GUIWIDTH,
    SUMO_ATTR_GUIOFFSET,
    SUMO_ATTR_GUISHAPE,
    SUMO_ATTR_EMISSIONCLASS,
    SUMO_ATTR_STARTPOS,
    SUMO_ATTR_ENDPOS,
    SUMO_ATTR_TRIGGERED,
    SUMO_ATTR_PARKING,
    SUMO_ATTR_INDEX,

    SUMO_ATTR_ENTERING,
    SUMO_ATTR_EXCLUDE_EMPTY,
    SUMO_ATTR_WITH_INTERNAL,
    SUMO_ATTR_TRACK_VEHICLES,
    SUMO_ATTR_MAX_TRAVELTIME,
    SUMO_ATTR_MIN_SAMPLES,

    SUMO_ATTR_LON,
    SUMO_ATTR_LAT,
    SUMO_ATTR_K,
    SUMO_ATTR_V,
    SUMO_ATTR_REF,
    SUMO_ATTR_HREF,
    SUMO_ATTR_ZOOM,
    SUMO_ATTR_INTERPOLATED,
    SUMO_ATTR_THRESHOLD,

    SUMO_ATTR_NET_OFFSET,
    SUMO_ATTR_CONV_BOUNDARY,
    SUMO_ATTR_ORIG_BOUNDARY,
    SUMO_ATTR_ORIG_PROJ,

    SUMO_ATTR_CF_PWAGNER2009_TAULAST,
    SUMO_ATTR_CF_PWAGNER2009_APPROB,
    SUMO_ATTR_CF_IDM_DELTA,
    SUMO_ATTR_CF_IDM_STEPPING,
    SUMO_ATTR_CF_IDMM_ADAPT_FACTOR,
    SUMO_ATTR_CF_IDMM_ADAPT_TIME,
    SUMO_ATTR_CF_KERNER_PHI,
    SUMO_ATTR_CF_WIEDEMANN_SECURITY,
    SUMO_ATTR_CF_WIEDEMANN_ESTIMATION,

    SUMO_ATTR_GENERATE_WALKS,

    /* general object */
    AGEN_ATTR_INHABITANTS,
    AGEN_ATTR_HOUSEHOLDS,
    AGEN_ATTR_CHILDREN,
    AGEN_ATTR_RETIREMENT,
    AGEN_ATTR_CARS,
    AGEN_ATTR_UNEMPLOYEMENT,
    AGEN_ATTR_MAX_FOOT_DIST,
    AGEN_ATTR_IN_TRAFFIC,
    AGEN_ATTR_OUT_TRAFFIC,

    /* streets object */
    //SUMO_ATTR_EDGE already defined
    AGEN_ATTR_POPULATION,
    AGEN_ATTR_OUT_WORKPOSITION,

    /* workHours object */
    AGEN_ATTR_HOUR,
    AGEN_ATTR_PROP,

    /* school object */
    //SUMO_ATTR_EDGE, SUMO_ATTR_POSITION, SUMO_ATTR_TYPE already defined
    AGEN_ATTR_CAPACITY,
    AGEN_ATTR_OPENING,
    AGEN_ATTR_CLOSING,

    /* busStation and Bus objects */
    // ID, EDGE, POSITION, REFID, BEGIN and END are already defined
    AGEN_ATTR_MAX_TRIP_DURATION,
    //AGEN_ATTR_ORDER,
    AGEN_ATTR_RATE,

    /* population and children accompaniment brackets */
    AGEN_ATTR_BEGINAGE,
    AGEN_ATTR_ENDAGE,
    AGEN_ATTR_PEOPLENBR,

    /* parameters */
    AGEN_ATTR_CARPREF,
    AGEN_ATTR_CITYSPEED,
    AGEN_ATTR_FREETIMERATE,
    AGEN_ATTR_UNI_RAND_TRAFFIC,
    AGEN_ATTR_DEP_VARIATION,

    /* city gates */
    AGEN_ATTR_INCOMING,
    AGEN_ATTR_OUTGOING,

    //@name Netedit Attributes (used as virtual property holders, must be in SumoXMLAttr)
    //
    /* whether a feature has been loaded,guessed,modified or approved */
    GNE_ATTR_MODIFICATION_STATUS,
    /* first coordinate of edge shape */
    GNE_ATTR_SHAPE_START,
    /* last coordinate of edge shape */
    GNE_ATTR_SHAPE_END
};

/*
 * definitions of special SumoXML-attribute values.
 * Since these enums shall be used in switch statements we keep them separated
 * @{
 */

enum SumoXMLNodeType {
    NODETYPE_UNKNOWN, // terminator
    NODETYPE_TRAFFIC_LIGHT,
    NODETYPE_PRIORITY_JUNCTION,
    NODETYPE_RIGHT_BEFORE_LEFT,
    NODETYPE_DISTRICT,
    NODETYPE_NOJUNCTION,
    NODETYPE_INTERNAL,
    NODETYPE_DEAD_END,
    NODETYPE_DEAD_END_DEPRECATED
};


enum SumoXMLEdgeFunc {
    EDGEFUNC_NORMAL,
    EDGEFUNC_CONNECTOR,
    EDGEFUNC_SINK,
    EDGEFUNC_SOURCE,
    EDGEFUNC_INTERNAL
};


enum LaneSpreadFunction {
    LANESPREAD_RIGHT,
    LANESPREAD_CENTER
};


enum LinkState {
    LINKSTATE_TL_GREEN_MAJOR = 'G',
    LINKSTATE_TL_GREEN_MINOR = 'g',
    LINKSTATE_TL_RED = 'r',
    LINKSTATE_TL_YELLOW_MAJOR = 'Y',
    LINKSTATE_TL_YELLOW_MINOR = 'y',
    LINKSTATE_TL_OFF_BLINKING = 'o',
    LINKSTATE_TL_OFF_NOSIGNAL = 'O',
    LINKSTATE_MAJOR = 'M',
    LINKSTATE_MINOR = 'm',
    LINKSTATE_EQUAL = '=',
    LINKSTATE_DEADEND = '-'
};


enum LinkDirection {
    LINKDIR_STRAIGHT = 0,
    LINKDIR_TURN,
    LINKDIR_LEFT,
    LINKDIR_RIGHT,
    LINKDIR_PARTLEFT,
    LINKDIR_PARTRIGHT,
    LINKDIR_NODIR
};


enum TrafficLightType {
    TLTYPE_STATIC,
    TLTYPE_ACTUATED,
    TLTYPE_AGENT
};



class SUMOXMLDefinitions {

public:
    static StringBijection<int>::Entry tags[];

    static StringBijection<int>::Entry attrs[];

    static StringBijection<int> Tags;

    static StringBijection<int> Attrs;


    static StringBijection<SumoXMLNodeType> NodeTypes;

    static StringBijection<SumoXMLEdgeFunc> EdgeFunctions;

    static StringBijection<LaneSpreadFunction> LaneSpreadFunctions;

    static StringBijection<LinkState> LinkStates;

    static StringBijection<LinkDirection> LinkDirections;

    static StringBijection<TrafficLightType> TrafficLightTypes;

private:

    static StringBijection<SumoXMLNodeType>::Entry sumoNodeTypeValues[];

    static StringBijection<SumoXMLEdgeFunc>::Entry sumoEdgeFuncValues[];

    static StringBijection<LaneSpreadFunction>::Entry laneSpreadFunctionValues[];

    static StringBijection<LinkState>::Entry linkStateValues[];

    static StringBijection<LinkDirection>::Entry linkDirectionValues[];

    static StringBijection<TrafficLightType>::Entry trafficLightTypesVales[];

};

#endif

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