Actor

Add or remove actor in SUMO scenario

Since R2026a

• 

Libraries:
Automated Driving Toolbox Interface for Eclipse SUMO Traffic Simulator

Description

Add-On Required: This feature requires the Automated Driving Toolbox Interface for Eclipse SUMO Traffic Simulator add-on.

The Actor block enables you to add or remove vehicle actors within a SUMO™ scenario during cosimulation. Use this block to add vehicles at a specified lane or position on the road network within a SUMO scenario. When adding a vehicle, you can use the parameters of this block to specify additional vehicle attributes, such as times at which it enters and exits the scenario, its speed, and the number of seats. This block enables you to model complex traffic scenarios and analyze the impact of dynamically changing traffic conditions within the SUMO environment.

Examples

Add Vehicle in SUMO Scenario Using Cosimulation with Simulink

Add vehicle to Eclipse™ SUMO scenario.

• Open Live Script

Ports

Input

Vehicle Id — ID of actor

string scalar

ID of the actor to add or remove from the SUMO scenario, specified as a string scalar.

Data Types: string

Reason — Reason to remove vehicle

scalar

Reason to remove the vehicle, specified as a positive integer in the range [0, 7].

Dependencies

To enable this port, set Functionality to Remove.

Data Types: uint8

Parameters

Actor type — Type of actor

Vehicle (default)

The Actor block supports adding and removing only vehicle actors from a SUMO scenario.

Functionality — Functionality to perform

Add (default) | Remove

Specifies whether the block adds the actor to or removes them from the SUMO scenario.

• Add — Add the actor to the SUMO scenario.

• Remove — Remove the actor from the SUMO scenario.

Spawning method — Method to add actor

Lane (default) | Position

The block adds the actor to the SUMO scenario using the specified method:

• Lane — Add the actor on a specified lane of the road network within the SUMO scenario.

• Position — Add the actor at a specified position on the road network within the SUMO scenario.

Dependencies

To enable this parameter, set Functionality to Add.

Use Route ID — Use route ID to add actor

off (default) | on

Select this parameter to enable the Route ID parameter, which you can use to specify the ID of the route on which you want to add the actor.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

Route ID — Route on which to add actor

valid route ID

Specify the ID of the route on which you want to add the actor as a valid route ID.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

• Select the Use Route ID.

Data Types: string

Depart time — Depart time of actor

now (default) | triggered | containerTriggered

Depart time is the simulation time step at which the actor enters the road network. The block determines actor depart time using as one of these options:

• now — The vehicle departs as soon as the Actor block adds the vehicle to the scenario.

• triggered — The vehicle departs when a person enters it.

• containerTriggered — The vehicle departs once a container attached to it has been loaded. A container represents a unit used to simulate the storage or transport of goods, materials, or items such as tank containers, bulk materials, food items, or animals.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

Depart lane — Depart lane of actor

first (default) | random | free | allowed | best

The depart lane is the lane onto which the actor enters the scenario. The block determines the depart lane of the actor using one of these options:

• first — The rightmost lane available for the vehicle to use.

• random — A random lane that the vehicle can traverse.

• free — The most free or least occupied lane the vehicle can traverse.

• allowed — The most free or least occupied lane the vehicle can traverse that enables it continue to the next route edge.

• best — The most free or least occupied lane the vehicle can traverse that requires the fewest lane changes.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

Depart position — Position of actor on depart lane

base (default) | random | random_free | free | last | stop

Depart position is the location on the depart lane at which the actor enters the scenario. The block determines the depart position of the actor using one of these options:

• random — Random position on the lane.

• free — Any available position on the lane.

• random_free — The block tries to position the vehicle at 10 random positions on the depart lane. If this operation fails, the block positions the vehicle at any available position on the depart lane.

• base — The block positions the vehicle with its rear at the start of the lane.

• last — The block positions the vehicle as close as possible to the rear of the last vehicle on the lane, or at the end of the lane if it is empty.

• stop — If a vehicle has a stop, it departs from the end position of the stop. Otherwise, the block positions the vehicle with its rear at the start of the lane.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

Depart speed — Speed of actor at depart time

random (default) | max | desired | speedLimit | last | avg

Depart speed is the speed at which the actor enters the scenario. The block determines the depart speed of the actor using one of these options:

• random — The actor enters with a random speed between 0 and the maximum depart speed of the vehicle. After entering, the vehicle adjusts its speed to ensure a safe distance to the leader vehicle, or upon approaching an intersection. The maximum depart speed of the vehicle depends on its type and speed factor.

• max — The actor enters at the maximum depart speed of the vehicle. After entering, the vehicle adjusts its speed to ensure a safe distance to the leader vehicle, or upon approaching an intersection. The maximum depart speed limit of the vehicle depends on its type and speed factor.

• desired — The maximum depart speed of the vehicle. If that speed is unsafe, departure is delayed.

• speedLimit — The actor attempts to enter at the speed limit of the depart lane. If that speed is unsafe, the actor delays departure.

• last — The actor enters at the current speed of the last vehicle in the departure lane. If the lane is empty, then the actor attempts to enter at the maximum depart speed. If that speed is unsafe, the actor delays departure.

• avg — The actor enters at the average speed of the vehicles already moving in the departure lane. If the lane is empty, the actor uses the lower value between the speed limit of the lane and the maximum departure speed of the vehicle. If that speed is unsafe, the actor delays departure.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

Arrival lane — Lane from which actor leaves

current (default) | random | first

The arrival lane is the lane from which the actor leaves the road network. The block determines the arrival lane of the actor using one of these options:

• current — The actor does not change its current lane when nearing arrival, and uses the most convenient lane to reach its arrival position.

• random — The actor selects a random, viable lane on its arrival edge, and changes lanes to arrive there only if necessary.

• first — The actor arrives on the rightmost viable lane.

Dependencies

To enable this parameter:

• Set Functionality parameter Add.

• Set Spawning method parameter Lane.

Arrival position — Position from which actor leaves

max (default) | random

The arrival position is the position from which the actor leaves the scenario. The block determines the arrival position of the actor using one of these options:

• max — The actor leaves upon reaching the end of its final lane.

• random — The actor leaves from a random position selected upon its departure. If you reroute the actor, then it selects a new random position from which to leave.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

Arrival speed — Speed at which actor leaves

current

The vehicle does not change its speed when nearing arrival, maintaining its maximum possible safe speed.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

Use Line ID — Use Line ID to add actor

off (default) | on

Select this parameter to enable the Line parameter, which enables you to specify the ID of the public transportation line on which to add the vehicle. You can select this parameter while adding vehicles carrying people. Selecting this parameter does not restrict you from specifying Person capacity and Person number values greater than 0.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

Line — Public transportation line on which to add actor

valid line ID

Specify the ID of public transportation line on which you want to add the actor as a valid line ID.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

• Select the Use Line ID parameter.

Data Types: string

Person capacity — Number of available seats in vehicle actor

0 (default) | positive integer

Specify the number of seats available in the vehicle actor as a positive integer.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

Data Types: uint8

Person number — Number of occupied seats in vehicle actor

0 (default) | positive integer

Specify the number of occupied seats in the vehicle actor, at the time it enters the scenario as a positive integer.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

Data Types: uint8

Use Traffic Assignment Zones (TAZ) — Use Traffic Assignment Zones (TAZs) for departure and arrival

off (default) | on

Selecting this parameter enables you to specify the IDs of the source TAZ from which the vehicle departs and the destination TAZ at which it arrives by using the From TAZ and To TAZ, respectively.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

From TAZ — Name of source TAZ

'' (default) | string

Specify the name of the TAZ from which the vehicle departs as a string.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

• Select the Use Traffic Assignment Zones (TAZ) parameter.

Data Types: string

To Taz — Name of destination Taz

'' (default) | string

Specify the name of the TAZ at which the vehicle arrives as a string.

Dependencies

To enable this parameter:

• Set Functionality to Add.

• Set Spawning method to Lane.

• Select the Use Traffic Assignment Zones (TAZ) parameter.

Data Types: string

Initial position — Initial position of actor

[0 0 0] (default) | 1-by-3 real-valued vector

Specify the position at which to insert the actor into the road network as 1-by-3 real-valued vector.

Dependencies

To enable this parameter, set these parameter in this order:

• Set Functionality to Add.

• Set Spawning method to Position.

Data Types: double

Sample time — Sample time of simulation

-1 (default) | positive real scalar

Specify the sample time of the simulation, in seconds, as a positive real scalar.

Version History

Introduced in R2026a