• Definition of Vehicles, Vehicle Types, and Routes

There are various applications that can be used to define vehicular demand for SUMO from existing input data. Traffic demand can also be created and edited visually with netedit. All these applications eventually create XML definitions.

Of course it is also possible to define the demand file manually or to edit generated files with a text editor. Before starting, it is important to know that a vehicle in SUMO consists of three parts:

• a vehicle type which describes the vehicle's physical properties,
• a route the vehicle shall take,
• and the vehicle itself.

Both routes and vehicle types can be shared by several vehicles. It is not mandatory to define a vehicle type. If not given, a default type is used. The driver of a vehicle does not have to be modelled explicitly. For the simulation of persons which walk around or ride in vehicles, additional definitions are necessary.

Vehicles and Routes#

Initially, we will define a vehicle with a route that belongs to it:

<routes>
    <vType id="type1" accel="0.8" decel="4.5" sigma="0.5" length="5" maxSpeed="70"/>

    <vehicle id="0" type="type1" depart="0" color="1,0,0">
      <route edges="beg middle end rend"/>
    </vehicle>

</routes>

By giving such a route definition to sumo (or sumo-gui), sumo will build a red (color=1,0,0) vehicle of type "type1" named "0" which starts at time 0. The vehicle will drive along the streets "beg", "middle", "end", and as soon as it has approached the edge "rend" it will be removed from the simulation.

This vehicle has its own internal route which is not shared with other vehicles. It is also possible to define two vehicles using the same route. In this case the route must be "externalized" - defined before being referenced by the vehicles. Also, the route must be named by giving it an id. The vehicles using the route refer it using the "route"-attribute. The complete change looks like this:

<routes>
    <vType id="type1" accel="0.8" decel="4.5" sigma="0.5" length="5" maxSpeed="70"/>

    <route id="route0" color="1,1,0" edges="beg middle end rend"/>

    <vehicle id="0" type="type1" route="route0" depart="0" color="1,0,0"/>
    <vehicle id="1" type="type1" route="route0" depart="0" color="0,1,0"/>

</routes>

Available Vehicle attributes#

A vehicle may be defined using the following attributes:

Repeated vehicles (Flows)#

It is possible to define repeated vehicle emissions ("flows"), which have the same parameters as the vehicle or trip definitions except for the departure time. The id of the created vehicles is "flowId.runningNumber" and they are distributed either equally or randomly in the given interval. The following additional parameters are known:

Flow can define their route explicitly (like vehicles) or with from,to,via (like trips):

<flow id="type1" color="1,1,0"  begin="0" end= "7200" period="900" type="BUS">
    <route edges="beg middle end rend"/>
    <stop busStop="station1" duration="30"/>
</flow>

<route id="route1" edges="beg middle end rend"/>
<flow id="type2" color="1,1,0"  begin="0" end= "7200" period="900" type="BUS" route="route1">
    <stop busStop="station1" duration="30"/>
</flow>

<flow id="type3" color="1,1,0"  begin="0" end= "7200" period="900" type="BUS" from="beg" to="end">
    <stop busStop="station1" duration="30"/>
</flow>

If you want to load unsorted vehicles / flows then load the file as an additional file. This will load the whole file at once and thus increase memory consumption. You can also use tools/route/sort_routes.py to sort the route file.

Routes#

One may notice, that the route itself also got a color definition, so the attributes of a route are:

There are a few important things to consider when building your own routes:

• Routes have to be connected. At the moment the simulation raises an error if the next edge of the current route is not a successor of the current edge or if the vehicle is not allowed to drive on any of the lanes. If you want the old behavior where a vehicle simply stopped at the end of the current edge and was possibly "teleported" to the next edge after a waiting time, use the Option --ignore-route-errors.
• Routes have to contain at least one edge.
• The route file has to be sorted by starting times. In fact this is only relevant, when you define a lot of routes or have large gaps between departure times. The simulation parameter --route-steps, which defaults to 200, defines the size of the time interval with which the simulation loads its routes. That means by default at startup, only routes with departure times <200 are loaded, if all the vehicles have departed, the routes up to departure time 400 are loaded etc. pp. This works only if the route file is sorted. This behavior may be disabled by specifying --route-steps 0. It is possible to load unsorted route files as an additional file which will load the whole file at once.

The first two conditions can be checked using <SUMO_HOME>/tools/route/routecheck.py, the third can be "fixed" using <SUMO_HOME>/tools/route/sort_routes.py.

Repeated Routes#

When using attribute 'repeat' to repeat a route. The number of edges will be repeated the given number of times after driving them for the first time. If route is defined as stand-alone route (defined with its own id outside a vehicle definition), any stops defined within the route will be repeated as well. If the stops use attribute 'until', they will be shifted by attribute 'cycleTime' in each iteration.

Incomplete Routes (trips and flows)#

Demand information for the simulation may also take the form of origin and destination edges instead of a complete list of edges. In this case the simulation performs fastest-path routing based on the traffic conditions found in the network at the time of departure/flow begin. Optionally, a list of intermediate edges can be specified with the via attribute. The input format is exactly the same as that for the duarouter application and can be found here.

<routes>
  <trip id="t" depart="0" from="beg" to="end"/>
  <flow id="f" begin="0" end="100" number="23" from="beg" to="end"/>
  <flow id="f2" begin="0" end="100" number="23" from="beg" to="end" via="e1 e23 e7"/>
</routes>

For more details on how to handle routing errors and influence the routing in this case see Demand/Automatic_Routing.

For supported attributes for flows and trips see here.

Traffic assignment zones (TAZ)#

It is also possible to let vehicles depart and arrive at traffic assignment zones (TAZ). This allows the departure and arrival edges to be selected from a predefined list of edges. Those edges are used which minimize the travel time from origin TAZ to destination TAZ. When loading trips into duarouter the loaded travel times are used (with empty-network travel times as default). When loading trips into sumo, the current travel times in the network are used as determined by the rerouting device.

<routes>
  <trip id="t" depart="0" fromTaz="taz1" toTaz="taz2"/>
</routes>

<additional>
  <taz id="<TAZ_ID>" edges="<EDGE_ID> <EDGE_ID> ..."/>
  ...
</additional>

When loading <taz> in sumo-gui the optional attribute shape can be used to draw an arbitrary polygon border for visualizing the traffic assignment zone.

Routing between Junctions#

Trips and flows may use the attributes fromJunction, toJunction, and viaJunctions to describe origin, destination and intermediate locations. This is a special form of TAZ-routing and it must be enabled by either setting the SUMO option --junction-taz or by loading TAZ-definitions that use the respective junction IDs. When using option --junction-taz, all edges outgoing from a junction may be used at the origin and all edges incoming to a junction may be used to reach the intermediate and final junctions.

Implicit Origin and Destination from Stops#

If a trip or flow defines at least one stop as child element, the attributes 'from' and 'to' may be omitted. In this case the edge of the first stop will be used as the 'from'-edge and the edge of the last stop will be used as the 'to'-edge.

A Vehicle's depart and arrival parameter#

Using the depart... and arrival...-attributes, it is possible to control how a vehicle is inserted into the network and how it leaves it.

depart#

Determines the time at which the vehicle enters the network (for <flow> the value of begin is used instead). If there is not enough space in the network, the actual depart time may be later.

• When using option --max-depart-delay <TIME> the vehicle is discarded if unable to depart after the given delay
• A random offset to the specified depart time is added for each vehicle when using option --random-depart-offset <TIME>
• When using the special value triggered, the vehicle will depart as soon as a person enters it.
• The special value begin will trigger a depart at simulation start. This is especially useful for taxi (or other public transport) fleets.

departLane#

Determines on which lane the vehicle is tried to be inserted;

• ≥0: the index of the lane, starting with rightmost=0
• "random": a random lane is chosen (among all lanes that allow the vehicle) Only a single random lane is tested per simulation step
• "free": the most free (least occupied) lane is chosen among all lanes that allow the vehicle
• "allowed": the most free (least occupied) lane is chosen among all lanes that allow the vehicle and also permit continuation to the next route edge
• "best": the most free (least occupied) lane is chosen among all lanes that allow the vehicle and which minimize the required number of future lane changes
• "first": the rightmost lane the vehicle may use

departPos#

Determines the position on the chosen departure lane at which the vehicle is tried to be inserted;

• ≥0: the position on the lane, starting at the lane's begin; must be smaller than the starting lane's length
• "random": a random position is chosen; it is not retried to insert the vehicle if the first try fails
• "free": a free position (if existing) is used
• "random_free": at first, ten random positions are tried, if all fail, "free" is applied
• "base": the vehicle is tried to be inserted at the position which lets its back be at the beginning of the lane (vehicle's front position=vehicle length)
• "last": the vehicle is inserted with the given speed as close as possible behind the last vehicle on the lane. If the lane is empty it is inserted at the end of the lane instead. When departSpeed="max" is set, vehicle speed will not be adapted.
• "stop": if the vehicle has a stop defined, it will depart at the endPos of the stop. If no stop is defined, the behavior defaults to "base"
• "splitFront": if the vehicle uses attribute depart="split", it will be inserted at the front of the vehicle from which it is split instead of the rear

departSpeed#

Determines the speed of the vehicle at insertion, where maxDepartSpeed = MIN(speedLimit * speedFactor, vType_desiredMaxSpeed * speedFactor, vType_maxSpeed);

• ≥0: The vehicle is tried to be inserted using the given speed. If that speed is unsafe, departure is delayed.
• "random": A random speed between 0 and maxDepartSpeed is used, the speed may be adapted to accommodate a leader or intersection ensure a safe distance to the leader vehicle.
• "max": The maxDeparSpeed is used when possible, the speed may be lowered to accommodate a leader vehicle or intersections.
• "desired": The maxDepartSpeed is used. If that speed is unsafe, departure is delayed.
• "speedLimit": The speed limit of the lane is used. If that speed is unsafe, departure is delayed.
• "last": The current speed of the last vehicle on the departure lane is used (or 'desired' speed if the lane is empty). If that speed is unsafe, departure is delayed.
• "avg": The average speed on the departure lane is used (or the minimum of 'speedLimit' and 'desired' if the lane is empty). If that speed is unsafe, departure is delayed.

departEdge#

Determines the edge along the vehicles route where the vehicle enters the network (By default this is 0: the first edge).

• integer index ≥0 and <routeLength: The vehicle is inserted at the given index
• "random": A random index along the route is used.

departPosLat#

The lateral position on the departure lane at which the vehicle enters the network. Defaults to 0

• FLOAT: the offset from the center of the line, a positive value indicates an offset to the right (in right-hand networks).
• "random": a random position within the lane is chosen; it is not retried to insert the vehicle if the first try fails
• "free": a free position (if existing) is used
• "random_free": at first, ten random positions are tried, if all fail, "free" is applied
• "center": center of the lane (offset 0). This is the default
• "left": touching the left border of the lane
• "right": touching the right border of the lane

arrivalLane#

Determines the lane on which the vehicle should end its route

• "current": the vehicle will not change its lane when nearing arrival. It will use whatever lane is more convenient to reach its arrival position. (default behavior)
• ≥0: the vehicle changes lanes to end its route on the specified lane
• "random": the vehicle will chose a random permitted lane on its arrival edge and if necessary change its lane to end there.
• "first": the vehicle will arrive on the rightmost permitted lane.

arrivalPos#

Determines the position along the destination edge where the vehicle is considered to have arrived;

• "max": the vehicle will drive up to the end of its final lane. (default behavior)
• <FLOAT>: the position on the lane, starting at the lane's begin; Negative values count from the end of the lane
• "random": a random position is chosen at departure; If vehicle is rerouted a new random position is selected.

arrivalSpeed#

Determines the speed at which the vehicle should end its route;

• "current": the vehicle will not modify its speed when nearing arrival. It will drive as fast as (safely) possible. (default behavior)
• ≥0: the vehicle approaches its arrival position to end with the specified speed

arrivalEdge#

Determines the edge along the vehicles route where the vehicle leaves the network (By default this is final edge).

• integer index ≥0 and <routeLength: The vehicle is inserted at the given index
• "random": A random index along the route is used.

arrivalPosLat#

The lateral position on the arrival lane at which the vehicle tries to finish its route

• FLOAT: the offset from the center of the line, a positive value indicates an offset to the right (in right-hand networks).
• "default": the vehicle may arrive at an arbitrary offset
• "center": center of the lane (offset 0). This is the default
• "left": touching the left border of the lane
• "right": touching the right border of the lane

Vehicle Types#

A vehicle is defined using the vType-element as shown below:

<routes>
    <vType id="type1" accel="2.6" decel="4.5" sigma="0.5" length="5" maxSpeed="70"/>
</routes>

Having defined this, one can build vehicles of type "type1". The values used above are the ones most of the examples use. They resemble a standard vehicle as used within the Stefan Krauß' thesis.

<routes>
    <vType id="type1" accel="2.6" decel="4.5" sigma="0.5" length="5" maxSpeed="70"/>
    <vehicle id="veh1" type="type1" depart="0">
        <route edges="edge1 edge2 edge3"/>
    </vehicle>
</routes>

This definition is the initial one which includes both, the definition of the vehicle's "purely physical" parameters, such as its length, its color, or its maximum velocity, and also the used car-following model's parameters. Please note that even though the car-following parameters are describing values such as max. acceleration, or max. deceleration, they mostly do not correspond to what one would assume. The maximum acceleration for example is not the car's maximum acceleration possibility but rather the maximum acceleration a driver choses - even if you have a Jaguar, you probably are not trying to go to 100km/h in 5s when driving through a city.

The default car following model is based on the work of Krauß but other models can be selected as well. Model selection and parameterization is done by setting further vType-attributes as shown below. The models and their parameters are described in the following.

<routes>
    <vType id="type1" length="5" maxSpeed="70" carFollowModel="Krauss" accel="2.6" decel="4.5" sigma="0.5"/>
</routes>

Available vType Attributes#

These values have the following meanings:

Besides values which describe the vehicle's car-following properties, one can find definitions of the assigned vehicles' shapes, emissions, and assignment to abstract vehicle classes. These concepts will be described in the following. Also, you may find further descriptions of implemented car-following models in the subsection #Car-Following Models.

Speed Distributions#

Individual Speed Factor#

The desired driving speed usually varies among the vehicle of a fleet. In SUMO this is modeled by assigning to each vehicle an individual multiplier which gets applied to the road speed limit. This multiplier is called the individual speedFactor or in short the speedFactor of a vehicle. The product of road speed limit and the individual speed factor gives the desired free flow driving speed of a vehicle. If the individual speedFactor is larger than 1, vehicles can exceed edge speeds. However, vehicle speeds are still capped at the vehicle type's maxSpeed.

While it is possible to assign the individual speedFactor value directly in a <vehicle>, <trip> or even <flow> definition using attribute speedFactor, a more common use case is to define the distribution of these factors for a <vType>.

Having a distribution of speed factors (and hence of desired speeds) is beneficial to the realism of a simulation. If the desired speed is constant among a fleet of vehicles, this implies that gaps between vehicles will keep their size constant over a long time. For this reason, the individual speed factor for each simulated vehicle (whether defined as <vehicle>, <trip> or part of a <flow>) is drawn from a distribution by default.

The speedFactor of a vehicle is also multiplied with the value of desiredMaxSpeed of its vType. The resulting value gives another upper bound on speed. This achieves speed distribution for road users where the speed limit is not meaningful (i.e. bicyles and pedestrians).

The speedFactor of a vehicle is written to various outputs (tripinfo-output, vehroute-output) and can also be checked via the vehicle parameter dialog.

Defining a normal distribution for vehicle speeds#

Two types of distributions can be defined for sampling the individual speedFactor of each vehicle by giving one of the following attributes in the <vType> element (without space characters between the distribution attributes):

• normal distribution: speedFactor="norm(mean,deviation)"
• truncated normal distribution: speedFactor="normc(mean,deviation,lowerCutOff,upperCutOff)"

The default for passenger cars is "normc(1,0.1,0.2,2)" which implies that ~95% of the vehicles drive between 80% and 120% of the legal speed limit.

Instead of giving the multi-parameter definition above, a simpler definition style is also possible.

• setting the deviation of the distribution directly: speedDev="0.3"
• setting the mean of the distribution directly: speedFactor="1.2"

When using the attributes in this way, the default cut-off range [0.2, 2] remains unchanged.

Vehicle class specific defaults#

When defining a vehicle type with a vClass, the following default speed-deviation will be used.

• passenger (default vClass): 0.1
• pedestrian: 0.1
• bicycle: 0.1
• truck, trailer, coach, delivery, taxi: 0.05
• tram, rail_urban, rail, rail_electric, rail_fast: 0
• emergency: 0
• everything else: 0.1

Global Configuration#

Instead of configuring speed distributions in a <vType> definition (as explained below), the sumo-option --default.speeddev <FLOAT> can be used to set a global default. The option value overrides all vClass-defaults. Setting --default.speeddev 0 estores pre-1.0.0 behavior.

Different distributions for cars and trucks#

The center of the speed distribution is defined relative to the road speed limit. On some roads, different speed limits may apply to cars and trucks. To model this, vClass-specific speed limits may be defined either in the network or directly in an additional file:

Note, that the given type id refers to an edge type rather than a vehicle type. The edge type may be set to an arbitrary value in the network file.

<type id="a" priority="3" numLanes="3" speed="38.89"/>
   <restriction vClass="truck" speed="27.89"/>
</type>

Additional remarks on speed distributions#

Examples#

Define a flow of vehicles that desire to drive at 120% of the speed limit without any deviation:

  <vType id="example" speedFactor="1.2" speedDev="0"/>
  <flow id="f" type="example" begin="0" end="3600" probability="0.2" from="A" to="B"/>

Define a vehicle type with high speed deviation and no cut-off

  <vType id="example2" speedFactor="norm(1.0,0.5)"/>

Vehicle Length#

Due to the work on car following models, we decided to use two values for vehicle length. The length-attribute describes the length of the vehicle itself. Additionally, the minGap-attribute describes the offset to the leading vehicle when standing in a jam.

This is illustrated in the following image:

Within the simulation, each vehicle needs - when ignoring the safe gap - length+minGap. But only length of the road should be marked as being occupied.

Abstract Vehicle Class#

A SUMO vehicle may be assigned to an "abstract vehicle class", defined by using the attribute vClass. These classes are used in lane definitions and allow/disallow the usage of lanes for certain vehicle types. One may think of having a road with three lanes, where the rightmost may only be used by "taxis" or "buses". The default vehicle class is passenger (denoting normal passenger cars).

The following vehicle classes exist:

These values are a "best guess" of somehow meaningful values, surely worth to be discussed. Though, in parts, they represent classes found in imported formats. They are "abstract" in the means that they are just names only, one could build a .5m long bus.

The following vehicle deprecated classes exist for maintaining backward compatibility:

Vehicle Emission Classes#

The emission class represents a certain emission class. It is defined using the emissionClass attribute. Possible values are given in Models/Emissions and its subsections.

Visualization#

For a nicer visualization of the traffic, the appearance of a vehicle type's vehicles may be changed by assigning them a certain shape using the guiShape attribute. These shapes are used when setting the drawing mode for vehicles to simple shapes. The following shapes are known:

• "pedestrian"
• "bicycle"
• "moped"
• "motorcycle"
• "passenger"
• "passenger/sedan"
• "passenger/hatchback"
• "passenger/wagon"
• "passenger/van"
• "taxi"
• "delivery"
• "truck"
• "truck/semitrailer" (13.5)
• "truck/trailer" (6.75)
• "bus"
• "bus/coach" (8.25)
• "bus/flexible" (8.25)
• "bus/trolley"
• "rail" (24.5)
• "rail/railcar" (16.85)
• "rail/cargo" (13.86)
• "evehicle"
• "ant"
• "ship"
• "emergency"
• "firebrigade"
• "police"
• "rickshaw"
• "scooter"
• "aircraft"

Some of these classes are drawn as a sequence of carriages. The length of a single carriage is indicated in parentheses after the type. For these types, the length of the vehicleType is used as the overall length of the train (all carriages combined). For example, a vehicle with shape rail/cargo and length 70m will have 5 carriages. The number of carriages will always be a whole number and no carriage will be shorter than the length given in brackets but may be longer to meet the length requirements of the whole vehicle. When drawing vehicles with raster images, the image will be repeated for each carriage.

In addition, one can determine the width of the vehicle using the attribute width. When using shapes, one should consider that different vehicle classes (passenger vehicles or buses) have different lengths. Passenger vehicles with more than 10m length look quite odd, buses with 2m length, too.

Carriages#

Further parameters can be used to achieve visualization of individual rail carriages and configure exiting behavior at stations.

<vType id="rail" vClass="rail" imgFile="locomotive.png">
    <param key="carriageLength" value="20"/>
    <param key="carriageGap" value="1"/>
    <param key="carriageImages" value="freight.png,passengers.png"/>
    <param key="locomotiveLength" value="25"/>
    <param key="frontSeatPos" value="1.7"/>
    <param key="seatingWidth" value="2.0"/>
    <param key="carriageDoors" value="2"/>
</vType>

Car-Following Models#

The car-following models currently implemented in SUMO are given in the following table.

Car-Following Model Parameters#

Mostly, each model uses its own set of parameters. The following table lists which parameter are used by which model(s). Details on car-following models and their parameters can be found here.

To select a car following model the following syntax should be used:

<vType id="idmAlternative" length="5" minGap="2" carFollowModel="IDM" tau="1.0" .../>

Default Krauss Model Description#

The default model is a modification of the model defined by Stefan Krauß in Microscopic Modeling of Traffic Flow: Investigation of Collision Free Vehicle Dynamics. The implemented model follows the same idea as that of Krauß, namely: Let vehicles drive as fast as possibly while maintaining perfect safety (always being able to avoid a collision if the leader starts braking within leader and follower maximum acceleration bounds). The implemented model as in <SUMO_HOME>/src/microsim/cfmodels/MSCFModel_Krauss.cpp has the following differences:

• Different deceleration capabilities among the vehicles are handled without violating safety (the original model allowed for collisions in this case)
• The formula for safe velocity was adapted to maintain safety when using the Ballistic-position update rule. This was done by discretizing some of the continuous terms. The original model was defined for the Euler-position updated rule and would produce collisions when using Ballistic. See also Simulation/Basic_Definition#Defining_the_Integration_Method.

Transient carFollowModel Parameters#

carFollowModel parameters that are expected to change during the simulation are modelled via generic parameters. The following parameters are supported (via xml input and traci.vehicle.setParameter):

• carFollowModel.ignoreIDs : ignore foe vehicles with the given ids
• carFollowModel.ignoreTypes : ignore foe vehicles that have any of the given types

If multiple ignore parameters are set, they are combined with "or". Foes are ignored while they are being followed. Example:

<vehicle id="ego" depart="0" route="r0">
   <param key="carFollowModel.ignoreIDs" value="foe1 foe2"/>
   <param key="carFollowModel.ignoreTypes" value="bikeType"/>
</vehicle>

See also transient junctionModel parameters.

Lane-Changing Models#

The lane-changing models currently implemented in SUMO are given in the following table.

Mostly, each model uses its own set of parameters. The following table lists which parameter are used by which model(s).

The parameters are set within the <vType>:

<vType id="myType" lcStrategic="0.5" lcCooperative="0.0"/>

Junction Model Parameters#

The behavior at intersections may be configured with the parameters listed below.

The parameters are set within the <vType>:

<vType id="ambulance" jmDriveAfterRedTime="300" jmDriveRedSpeed="5.56"/>

Impatience#

The impatience of a driver is value between 0 and 1 that grows whenever the driver has to stop unintentionally (i.e. due to a jam or waiting at an intersection). The impatience value is computed as

MAX(0, MIN(1.0, baseImpatience + waitingTime / timeToMaxImpatience))

Where baseImpatience is configured by setting the vType-attribute impatience and timeToMaxImpatience is set using the option --time-to-impatience (default 180s). Setting this option to 0 disables impatience growth. The value of baseImpatience may be negative to slow the growth of the dynamically computed impatience. It may also be defined with the value off to prevent drivers from becoming impatient.

The impatience value is used to represent a drivers willingness to impede vehicles with higher priority. At a value of 1 or above, the driver will use any gap that is safe in the sense of collision-avoidance even if it means that another vehicle has to brake as hard as it can. At a value of 0, the driver will only perform maneuvers that do not force other vehicles to slow down. Intermediate values interpolate smoothly between these extremes.

Impatience for Pedestrians#

The impatience concept is also used when pedestrians cross a street without having priority. Just as for cars, the current impatience is computed from the baseImpatience (as configured in the vType) and the current waitingTime. The timeToMaxImpatience is hard-coded as 120s. Impatient pedestrians may cross the street even though it forces cars to brake. Setting impatience in the vType to a negative value or off can be used to make pedestrians more patient.

Transient Parameters#

Junction model parameters that are expected to change during the simulation are modelled via generic parameters. The following parameters are supported (via xml input and traci.vehicle.setParameter):

• junctionModel.ignoreIDs : ignore foe vehicles with the given ids
• junctionModel.ignoreTypes : ignore foe vehicles that have any of the given types

If multiple ignore parameters are set, they are combined with "or". Foes are ignored while they are approaching a junction and also while they are on the junction.

Example:

<vehicle id="ego" depart="0" route="r0">
   <param key="junctionModel.ignoreIDs" value="foe1 foe2"/>
   <param key="junctionModel.ignoreTypes" value="bikeType"/>
</vehicle>

Default Vehicle Type#

If the type attribute of a vehicle is not defined it defaults to "DEFAULT_VEHTYPE". By defining a vehicle type with this id (<vType id="DEFAULT_VEHTYPE" ..../>) the default parameters for vehicles without an explicitly defined type can be changed. The change of the default vehicle type needs to occur before any reference to the type was made, so basically before any vehicle or vehicle type was defined. So it should always be at the top of the very first route file.

Route and vehicle type distributions#

Instead of defining routes and vTypes explicitly for a vehicle sumo can choose them at runtime from a given distribution. In order to use this feature just define distributions as following:

Vehicle Type Distributions#

<routes>
    <vTypeDistribution id="typedist1">
        <vType id="type1" accel="0.8" length="5" maxSpeed="70" probability="0.9"/>
        <vType id="type2" accel="1.8" length="15" maxSpeed="50" probability="0.1"/>
    </vTypeDistribution>
</routes>

Using existing types#

Multiple distributions can make use of the same types and optionally override their probabilities. Previously defined vehicle type distributions can be referenced as well.

<routes>
    <vType id="type1" accel="0.8" length="5" maxSpeed="70" probability="0.9"/>
    <vType id="type2" accel="1.8" length="15" maxSpeed="50" probability="0.1"/>
    <vType id="type3" accel="1.9" length="15" maxSpeed="50"/>
    <vType id="type4" accel="1.7" length="12" maxSpeed="50"/>
    <vTypeDistribution id="typedist1" vTypes="type1 type2"/>
    <vTypeDistribution id="typedist2" vTypes="type3 type4"/>
    <vTypeDistribution id="typedist3" vTypes="type1 type2" probabilities="0.5 0.5"/>
    <vTypeDistribution id="alltypesdist" vTypes="typedist1 typedist2" probabilities="0.5 0.5"/>
</routes>

Route Distributions#

<routes>
    <routeDistribution id="routedist1">
        <route id="route0" color="1,1,0" edges="beg middle end rend" probability="0.9"/>
        <route id="route1" color="1,2,0" edges="beg middle end" probability="0.1"/>
    </routeDistribution>

    <route id="route2" edges="beg middle end rend"/>
    <route id="route3" edges="beg middle end"/>
    <routeDistribution id="routedist2">
        <route refId="route2" probability="2"/>
        <route refId="route3" probability="3"/>
    </routeDistribution>
</routes>

A distribution has only an id as (mandatory) attribute and needs a probability attribute for each of its child elements. The sum of the probability values needs not to be 1, they are scaled accordingly. Note, that probability defaults to 1.00 when not specified. At the moment the id for the children is mandatory, this is likely to change in future versions.

A distribution can be used just as using individual types and routes:

<routes>
    <vehicle id="0" type="typedist1" route="routedist1" depart="0" color="1,0,0"/>
</routes>

Stops and waypoints#

Vehicles may be forced to stop for a defined time span or wait for persons by using the stop element either as part of a route or a vehicle definition. The stop element can also be used to guide vehicles along a route to a waypoint. The examples below show all three cases:

<routes>
    <route id="route0" edges="beg middle end rend">
        <stop lane="middle_0" endPos="50" duration="20"/>
    </route>
    <vehicle id="v0" route="route0" depart="0">
        <stop lane="end_0" endPos="10" until="50"/>
    </vehicle>
    <vehicle id="v1" route="route0" depart="90">
        <stop lane="end_1" endPos="10" speed="13.89"/>
    </vehicle>
</routes>

The resulting vehicle v0 will stop twice, once at lane middle_0 because of the stop defined in its route and the second time because of the stop defined in the vehicle itself. The first stop will last 20 seconds the second one until simulation second 50. For a detailed list of attributes to stops see below. For a description on how to use them to simulate public transport see Simulation/Public Transport. The second vehicle v1 will stop once at lane middle_0 as defined in the route, then head to lane end_1 and pass that point at 13.89 m/s before terminating at route at rend edge.

Stops can be childs of vehicles, routes, persons or containers.

• If "duration" and "until" are given, the vehicle will stop for at least "duration" seconds.
• If "duration" is 0 the vehicle will decelerate to reach velocity 0 and then start to accelerate again.
• If "until" is given and "duration" is not and the vehicle arrives at the stop at or after the time step defined by "until" it will decelerate to speed 0 and then accelerate again.
• If persons board the vehicle, the stop is extended by the "boardingDuration" of the vehicle or until the "personCapacity" is reached. (or "loadingDuration" and "containerCapacity" for containers).
• If until is defined in the context of a repeated vehicle insertion (flow) it will be incremented by the difference of vehicle creation time and "begin" of the flow.
• If neither "duration" nor "until" are given, "triggered" defaults to true. If "triggered" is set to false explicitly the vehicle will stop forever.
• if "duration" or "until" are given along with "triggered", then the vehicle will stop until the given duration/until is reached and a person has boarded
• If "parking" is set to true. The vehicle stops besides the road without blocking other vehicles.

startPos and endPos#

• by default vehicles will try to stop at the given endPos
• if the vehicle comes to a halt earlier (i.e. due to a jam) then the stop counts as reached if the vehicle front is between startPos and endPos
• if the vehicle picks up a person or container, it can do so as long as the person is between startPos and endPos
• if the stop uses attribute 'speed', than that speed will be maintained between startPos and endPos

triggered stops#

Typically, a planned stop ends based on a time related condition (a scheduled departure time give as until or a minimum stopping duration or both). However, it is also possible to set other requirements that must be met for the stop to end and these are defined with attribute triggered. The attribute defines a list of conditions and each keyword is explained in the following:

• "person": the vehicle stops until at least one person has entered
  • the list of necessary and eligible persons can be further customized with attributes expected and permitted
• "container": the vehicle stops until at least one container has been loaded
  • the list of necessary and eligible containers can be further customized with attributes expectedContainers and permitted
• "join": the vehicle stops until having joined with another vehicle
• "true": alias for "person"
• "false": alias for not defining any trigger conditions

Waypoints#

By defining attribute 'speed' with a positive value, the stop definition is turned into a waypoint. The vehicle will drive past the given lane and keep at most the defined speed while between startPos end endPos. The actual vehicle speed cannot be higher than it would be without a waypoint.

Special handling of other attributes:

• the 'duration' value is ignored
• the 'triggered' value is not compatible with waypoints and will trigger an error
• when the 'until' value is set, vehicles may stop when reaching a waypoint too early

Jumps#

When defining attribute 'jump' with a non-negative value, the vehicle will leave the network for the given duration immediately after finishing the stop and re-enter it on the start of the next edge of its route. Having a disconnected route after a jump-stop is permitted. When giving jumps as router input, disconnected routes are created by design.

A typical use case for jumps would be a public transport vehicle that has some of its stops outside the simulated area and is expected to re-enter it at a later time after leaving the simulation (while preserving its ID and delay).

User defined Parameters#

Stops support Generic Parameters. These may also be retrieved and modified via TraCI

<trip id="r0" depart="0"/>
  <stop edge="E0" duration="10">
      <param key="userDefined" value="42"/>
  </stop>
</trip>

Colors#

A color is defined as red,green,blue or red,green,blue,alpha either in a vehicle, route or vType.

<route id="r0" color="0,255,255"/>
<type id="t0" color="0,0,255"/>
<vehicle id="v0" color="255,0,0,0"/>

In the default visualization settings the vehicle color will be used if define, otherwise the type and finally the route color. These settings can be changed.

By default color components should be given as integers in the range of (0,255) but other definitions are also supported:

color="0.5, 0.5, 1.0"
color="#FF0000"
color="red"

The transparency value (alpha) only takes effect when also using the vType attribute imgFile.

Devices#

Vehicle devices are used to model and configure different aspects such as output (device.fcd) or behavior (device.rerouting).

The following device names are supported and can be used for the placeholder <DEVICENAME> below

• emission
• battery
• stationfinder
• elechybrid
• btreiver
• btsender
• bluelight
• rerouting
• ssm
• toc
• driverstate
• fcd
• tripinfo
• vehroute
• taxi
• glosa
• example

Automatic assignment#

Some devices are assigned automatically. Every <trip> that is loaded into the simulation is automatically equipped with a rerouting device to perform the initial route computation.

Other devices such as fcd are assigned automatically when the option --fcd-output is set.

Assignment by global options#

Devices can be configured globally for all vehicles in the simulation by setting the option --device.<DEVICENAME>.probability (e.g. --device.fcd.probability 0.25. This will equip about a quarter of the vehicles with an fcd device (each vehicle determines this randomly with 25% probability).) To make the assignment exact the additional option --device.<DEVICENAME>.deterministic can be set. Another option is to pass the list of vehicle ids that shall be equipped using the option --device.<DEVICENAME>.explicit <ID1,ID2,...IDk>.

Assignment by generic parameters#

Another option for assigning devices for vehicle types or individual vehicles is by using generic parameters. This is done by defining them for the vehicle or the vehicle type in the following way:

<routes>
    <vehicle id="v0" route="route0" depart="0">
        <param key="has.<DEVICENAME>.device" value="true"/>
    </vehicle>

    <vType id="t1">
        <param key="has.<DEVICENAME>.device" value="true"/>
    </vType>

    <vehicle id="v1" route="route0" depart="0" type="t1"/>

    <vType id="t2">
        <param key="device.<DEVICENAME>.probability" value="0.5"/>
    </vType>

    <vehicle id="v2" route="route0" depart="0" type="t2"/>
</routes>