SUMO - Simulation of Urban MObility
SUMOXMLDefinitions.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2002-2018 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
20 // Definitions of elements and attributes known by SUMO
21 /****************************************************************************/
22 #ifndef SUMOXMLDefinitions_h
23 #define SUMOXMLDefinitions_h
24 
25 
26 // ===========================================================================
27 // included modules
28 // ===========================================================================
29 #include <config.h>
30 
32 
33 // ===========================================================================
34 // definitions
35 // ===========================================================================
42 enum SumoXMLTag {
212 
218 
250 
253 
271 
279 
289 
320  //AGEN_TAG_CHILD_ACOMP,
327 };
328 
329 
339 
365 
378 
385 
388 
424 
436 
466 
486 
502 
505  SUMO_ATTR_SIGMA, // used by: Krauss
506  SUMO_ATTR_TAU, // Krauss
513 
514  // @name Train ACC model attributes
524 
525  // @name Train CACC model attributes
535 
536 
539  SUMO_ATTR_TRAIN_TYPE, //used by: Rail
541 
563 
575 
586 
604 
619 
663 
671 
681 
687 
699 
706 
746 
753 
766 
771 
784 
798 
809 
810 
813 
827 
830  //SUMO_ATTR_EDGE already defined
834 
840 
843  //SUMO_ATTR_EDGE, SUMO_ATTR_POSITION, SUMO_ATTR_TYPE already defined
848 
851  // ID, EDGE, POSITION, REFID, BEGIN and END are already defined
853  //AGEN_ATTR_ORDER,
856 
863 
872 
879 
880  //@name Netedit Attributes (used as virtual property holders, must be in SumoXMLAttr)
916  // @}
917 
922 
923  //@name RNG state saving attributes
924  // @{
931  // @}
932 
933 };
934 
935 /*
936  * @brief definitions of special SumoXML-attribute values.
937  * Since these enums shall be used in switch statements we keep them separated
938  * @{
939  */
940 
945 extern const std::string SUMO_PARAM_ORIGID;
946 
953  NODETYPE_UNKNOWN, // terminator
955  NODETYPE_TRAFFIC_LIGHT_NOJUNCTION, // junction controlled only by traffic light but without other prohibitions,
960  NODETYPE_PRIORITY_STOP, // like priority but all minor links have stop signs
969 };
970 
971 
984 };
985 
986 
998 };
999 
1000 
1005 };
1006 
1007 
1051 };
1052 
1076 };
1077 
1078 
1094  TLTYPE_INVALID //< must be the last one
1095 };
1096 
1097 
1107  LCA_STAY = 1 << 0,
1109  LCA_LEFT = 1 << 1,
1111  LCA_RIGHT = 1 << 2,
1113  LCA_STRATEGIC = 1 << 3,
1117  LCA_SPEEDGAIN = 1 << 5,
1119  LCA_KEEPRIGHT = 1 << 6,
1121  LCA_TRACI = 1 << 7,
1123  LCA_URGENT = 1 << 8,
1125  LCA_UNKNOWN = 1 << 30,
1127 
1139  LCA_OVERLAPPING = 1 << 13,
1143  LCA_SUBLANE = 1 << 15,
1162  // LCA_BLOCKED_BY_CURRENT_LEADER = 1 << 28
1163  // LCA_BLOCKED_BY_CURRENT_FOLLOWER = 1 << 29
1165 
1171  LCA_MRIGHT = 1 << 18,
1172  LCA_MLEFT = 1 << 19,
1173  // !!! never set LCA_UNBLOCK = 1 << 20,
1175  // !!! never used LCA_AMBLOCKINGSECONDFOLLOWER = 1 << 22,
1177  // !!! never read LCA_KEEP1 = 1 << 24,
1178  // !!! never used LCA_KEEP2 = 1 << 25,
1182 };
1183 
1184 
1191 };
1192 
1211 };
1212 
1213 // @}
1214 
1220 
1221 public:
1224 
1227 
1230 
1233 
1236 
1239 
1242 
1245 
1248 
1251 
1254 
1257 
1260 
1263 
1266 
1270 
1273 
1275  static bool isValidNetID(const std::string& value);
1276 
1278  static bool isValidVehicleID(const std::string& value);
1279 
1281  static bool isValidTypeID(const std::string& value);
1282 
1284  static bool isValidDetectorID(const std::string& value);
1285 
1287  static bool isValidAttribute(const std::string& value);
1288 
1290  static bool isValidFilename(const std::string& value);
1291 
1293  static bool isValidListOfNetIDs(const std::string& value);
1294 
1296  static bool isValidListOfTypeID(const std::string& value);
1297 
1299  static bool isValidGenericParameterKey(const std::string& value);
1300 
1302  static bool isValidGenericParameterValue(const std::string& value);
1303 
1305  static std::string getJunctionIDFromInternalEdge(const std::string internalEdge);
1306 
1308  static std::string getEdgeIDFromLane(const std::string laneID);
1310 
1312  static const std::string ALLOWED_TLS_LINKSTATES;
1313 
1314 
1315 
1316 private:
1319 
1322 
1325 
1328 
1331 
1334 
1337 
1340 
1343 
1346 
1349 
1353 
1356 };
1357 
1358 #endif
1359 
1360 
1361 /****************************************************************************/
number of steps that a vehicle is charging
The information about how to spread the lanes from the given position.
static StringBijection< LaneChangeModel >::Entry laneChangeModelValues[]
lane change model values
static StringBijection< RightOfWay > RightOfWayValues
lane spread functions
The link is a partial left direction.
average sink (used only by TAZs)
The link has green light, may pass.
Internal moment of inertia.
segment of a lane
static StringBijection< SumoXMLTag > CarFollowModels
car following models
SumoXMLTag
Numbers representing SUMO-XML - element names.
static StringBijection< SumoXMLNodeType > NodeTypes
node types
a routeprobe detector
static StringBijection< LinkDirection >::Entry linkDirectionValues[]
link direction values
a list of node ids, used for controlling joining
alternative tag for e1 detector
description of a vehicle type
Whether vehicles must keep the junction clear.
split something
whether a given shape is user-defined
a source within a district (connection road)
The action is due to the default of keeping right "Rechtsfahrgebot".
ActivityGen Tags.
The action is done to help someone else.
static StringBijection< int >::Entry attrs[]
The names of SUMO-XML attributes (for passing to GenericSAXHandler)
static bool isValidAttribute(const std::string &value)
whether the given string is a valid attribute for a certain key (for example, a name) ...
static StringBijection< LinkState >::Entry linkStateValues[]
link state values
static bool isValidListOfTypeID(const std::string &value)
whether the given string is a valid list of ids for an edge or vehicle type (empty aren&#39;t allowed) ...
root element of a network file
begin/end of the description of a junction
begin/end of the description of a single lane
a flow definition (used by router)
block shape of a graphic element (Used mainly in GNEShapes)
Outgoing edge specification (jtrrouter)
static StringBijection< LaneSpreadFunction >::Entry laneSpreadFunctionValues[]
lane spread function values
A calibrator placed over edge.
an e2 detector over multiple lanes (used by Netedit)
static StringBijection< LaneSpreadFunction > LaneSpreadFunctions
lane spread functions
The vehicle is blocked by left follower.
a traffic assignment zone
static const std::string ALLOWED_TLS_LINKSTATES
all allowed characters for phase state
distribution of a route
lane of a reroute of type closing
A layer number.
The link has green light, has to brake.
connectio between two lanes
This is an uncontrolled, minor link, has to stop.
Allow/disallow charge in transit in Charging Stations.
static StringBijection< LateralAlignment >::Entry lateralAlignmentValues[]
lanteral alignment values
static std::string getJunctionIDFromInternalEdge(const std::string internalEdge)
return the junction id when given an edge of type internal, crossing or WalkingArea ...
workingHours object
closing for workingHours object
foe visibility distance of a link
population and children accompaniment brackets
The link is a 180 degree turn.
Wants go to the right.
Close shape of a polygon (Used by GNEPolys)
lane can change or stay
Vehicle is too slow to guarantee success of lane change (used for continuous lane changing in case th...
a flow state definition (used when saving and loading simulatino state)
weights: time range begin
link,node: the traffic light id responsible for this link
Color of TAZSources/TAZChilds.
This is a dead end link.
tgotal of Energy charged
SumoXMLAttr
Numbers representing SUMO-XML - attributes.
begin/end of the description of a Point of interest
This is an uncontrolled, right-before-left link.
max source (used only by TAZs)
maximum duration of a phase
min sink (used only by TAZs)
align with the closest sublane border
static StringBijection< LinkState > LinkStates
link states
static StringBijection< SumoXMLNodeType >::Entry sumoNodeTypeValues[]
containers for the different SUMOXMLDefinitions
drive on the right side
begin/end of the description of an edge restriction
The link is controlled by a tls which is off, not blinking, may pass.
A parking space for a single vehicle within a parking area.
Wants go to the left.
first coordinate of edge shape
static bool isValidGenericParameterKey(const std::string &value)
whether the given string is a valid key for a generic parameter
This is an uncontrolled, all-way stop link.
The action is due to the wish to be faster (tactical lc)
RightOfWay
algorithms for computing right of way
generic attribute
used by the sublane model
prohibition of circulation between two edges
The link is a (hard) left direction.
This is an uncontrolled, zipper-merge link.
begin/end of the description of a route
LateralAlignment
Numbers representing special SUMO-XML-attribute values Information how vehicles align themselves with...
Position on lane.
an e3 entry point
Sink(s) specification.
link: the index of the opposite direction link of a pedestrian crossing
whether a feature has been loaded,guessed,modified or approved
Radial drag coefficient.
LinkDirection
The different directions a link between two lanes may take (or a stream between two edges)...
an edge based mean data detector
The link is a straight direction.
Needs to stay on the current lane.
The state of a link.
drive on the left side
static StringBijection< LinkDirection > LinkDirections
link directions
reasons of lane change
LaneChangeModel
alternative definition for Population
The action has not been determined.
The definition of a periodic event.
How to compute right of way.
root element of a route file
The turning radius at an intersection in m.
min source (used only by TAZs)
whether an edge is part of a bidirectional railway
static StringBijection< LaneChangeAction > LaneChangeActions
lane change actions
static bool isValidGenericParameterValue(const std::string &value)
whether the given string is a valid value for a generic parameter
blocked in all directions
the edges of a route
station for a certain vehicle
rev stations for certain vehicles
max sink (used only by TAZs)
The action is urgent (to be defined by lc-model)
frequency of a object
An instantenous induction loop.
static StringBijection< TrafficLightType > TrafficLightTypes
traffic light types
This is an uncontrolled, minor link, has to brake.
walking area for pedestrians
parameter associated to a certain key
an e3 exit point
timesteps in which charging ends
schools object
static bool isValidDetectorID(const std::string &value)
whether the given string is a valid id for an detector
An edge-following detector.
A calibrator placed over lane (used in netedit)
busStation and bus objects
block movement of a graphic element
LinkState
The right-of-way state of a link between two lanes used when constructing a NBTrafficLightLogic, in MSLink and GNEInternalLane.
invalid attribute
definition of a detector
roundabout defined in junction
Incoming edge specification (jtrrouter)
energy provied by charging station at certain timestep
The link is a (hard) right direction.
Energy charged in transit.
The action is needed to follow the route (navigational lc)
node: the type of traffic light
edge: the shape in xml-definition
probability of route of a reroute
probability of destiny of a reroute
begin/end of the description of a neighboring lane
maintain the current alignment
class for maintaining associations between enums and xml-strings
The link is a partial right direction.
description of a logic request within the junction
streets object
begin/end of the description of an edge
timestep in which charging begins
static bool isValidNetID(const std::string &value)
whether the given string is a valid id for a network element
reroute of type closing
succesor phase index
drive in the middle
entry for an alternative parking zone
static StringBijection< int >::Entry tags[]
The names of SUMO-XML elements (for passing to GenericSAXHandler)
static StringBijection< LateralAlignment > LateralAlignments
lateral alignments
stop for vehicles
a lane based mean data detector
trigger: the time of the step
LaneChangeAction
The state of a vehicle&#39;s lane-change behavior.
A train stop (alias for bus stop)
alternative definition for city entrances
a sink within a district (connection road)
the edges crossed by a pedestrian crossing
static StringBijection< LaneChangeAction >::Entry laneChangeActionValues[]
lane change action values
The link has yellow light, may pass.
SumoXMLNodeType
Numbers representing special SUMO-XML-attribute values for representing node- (junction-) types used ...
static StringBijection< RightOfWay >::Entry rightOfWayValuesInitializer[]
lane spread function values
The vehicle is blocked being overlapping.
The link is controlled by a tls which is off and blinks, has to brake.
static StringBijection< int > Attrs
The names of SUMO-XML attributes for use in netbuild.
weights: time range end
Join operation.
a vtypeprobe detector
element is selected
alternative definition for junction
static bool isValidListOfNetIDs(const std::string &value)
whether the given string is a valid list of id for a network (empty aren&#39;t allowed) ...
The link has red light (must brake)
Energy charged stopped.
SumoXMLEdgeFunc
Numbers representing special SUMO-XML-attribute values for representing edge functions used in netbui...
This is an uncontrolled, major link, may pass.
const std::string SUMO_PARAM_ORIGID
total energy charged into a single vehicle
crossing between edges for pedestrians
LaneSpreadFunction
Numbers representing special SUMO-XML-attribute values Information how the edge&#39;s lateral offset shal...
vaporizer of vehicles
The abstract direction of a link.
align with the rightmost sublane that allows keeping the current speed
description of a vehicle
an aggreagated-output interval
The action is due to a TraCI request.
The link is a 180 degree turn (left-hand network)
average source (used only by TAZs)
static StringBijection< SumoXMLTag >::Entry carFollowModelValues[]
car follwing model values
A variable speed sign.
Eficiency of the charge in Charging Stations.
The vehicle does not have enough space to complete a continuous lane and change before the next turni...
link: the index of the link within the traffic light
last coordinate of edge shape
a single trip definition (used by router)
type of polygon
parent of an additional element
static StringBijection< int > Tags
The names of SUMO-XML elements for use in netbuild.
a traffic light logic
static const char AllowedTLS_linkStatesInitializer[]
all allowed characters for phase state
static bool isValidTypeID(const std::string &value)
whether the given string is a valid id for an edge or vehicle type
Delay in the charge of charging stations.
static StringBijection< SumoXMLEdgeFunc >::Entry sumoEdgeFuncValues[]
edge function values
The link has yellow light, has to brake anyway.
opening for workingHours object
The vehicle is blocked by right leader.
delete certain element
begin/end of the description of a Point of interest over Lane (used by Netedit)
static std::string getEdgeIDFromLane(const std::string laneID)
return edge id when given the lane ID
static StringBijection< SumoXMLEdgeFunc > EdgeFunctions
edge functions
blocker by follower
An access point for a train stop.
distribution of a vehicle type
static bool isValidFilename(const std::string &value)
whether the given string is a valid attribute for a filename (for example, a name) ...
A color information.
The link has red light (must brake) but indicates upcoming green.
a single phase description
The vehicle is blocked by right follower.
static StringBijection< LaneChangeModel > LaneChangeModels
lane change models
alternative tag for e3 detector
static bool isValidVehicleID(const std::string &value)
whether the given string is a valid id for a vehicle or flow
Fill the polygon.
alternative tag for e2 detector
stations for certain vehicles
join exlude operation
TrafficLightType
static StringBijection< TrafficLightType >::Entry trafficLightTypesValues[]
traffic light types values
begin/end of the description of a polygon
trigger: a step description
The link has no direction (is a dead end link)
Information on vClass specific stop offsets at lane end.