Struct Simulation

pub struct Simulation { /* private fields */ }

A traffic simulation.

Implementations

impl Simulation

pub fn new() -> Self

Creates a new simulation.

pub fn add_link(&mut self, attributes: &LinkAttributes<'_>) -> LinkId

Adds a link to the network.

pub fn add_link_group(&mut self, link_ids: &[LinkId])

Specifies that these vehicles on these links may interact with vehicles on other links in the group.

pub fn add_lane_change(&mut self, from: LinkId, to: LinkId)

Permits vehicles to lane change from the from link to the to link. Both links must belong to the same LinkGroup.

pub fn add_link_convergance(&mut self, a: LinkId, b: LinkId)

Specifies that two links may converge or cross.

pub fn add_link_connection(&mut self, from: LinkId, to: LinkId)

Specifies that the end of the from link connects to the start of the to link.

pub fn add_traffic_light(&mut self, light: TrafficLight) -> TrafficLightId

Adds a traffic light to the simulation.

pub fn add_vehicle( &mut self, attributes: &VehicleAttributes, link: LinkId, ) -> VehicleId

Adds a vehicle to the simulation.

pub fn set_vehicle_frozen(&mut self, vehicle_id: VehicleId, frozen: bool)

Sets the frozen attribute of a vehicle. When a vehicle is frozen, it will maximally decelerate until its velocity is zero and remain stopped until it is no longer frozen.

pub fn get_vehicle_frozen(&mut self, vehicle_id: VehicleId) -> bool

Gets the frozen attribute of a vehicle. .

pub fn step(&mut self, dt: f64)

Advances the simulation by dt seconds.

For a realistic simulation, do not use a time step greater than around 0.2.

pub fn step_fast(&mut self, dt: f64)

Advances the simulation by dt seconds, but only integrates vehicles positions, and doesn’t recalculate more expensive aspects of the simulation.

Use this to achieve better performance while retaining a smooth animation frame rate, though beware that simulating too many consecutive frames with this method will result in a noticeable degradation in simulation quality and realism.

pub fn frame(&self) -> usize

Gets the current simulation frame index.

pub fn iter_links(&self) -> impl Iterator<Item = &Link>

Returns an iterator over all the links in the simulation.

pub fn iter_vehicles(&self) -> impl Iterator<Item = &Vehicle>

Returns an iterator over all the vehicles in the simulation.

pub fn get_vehicle(&self, vehicle_id: VehicleId) -> &Vehicle

Gets a reference to the vehicle with the given ID.

pub fn get_link(&self, link_id: LinkId) -> &Link

Gets a reference to the link with the given ID.

pub fn set_link_control(&mut self, link_id: LinkId, control: TrafficControl)

Sets the TrafficControl at the start of the given link.

pub fn debug(&mut self) -> Value

Gets the debugging information for the previously simulated frame as JSON array.

pub fn do_lane_change( &mut self, vehicle_id: VehicleId, link_id: LinkId, distance: f64, )

Causes the given vehicle to change lanes from its current link to the specified link. It will smoothly transition from one to the other over the given distance specified in metres.

pub fn set_vehicle_route(&mut self, vehicle_id: VehicleId, route: &[LinkId])

Sets the route for the given vehicle, which is the list of links it will traverse after it has exited its current link.

Trait Implementations

impl Clone for Simulation

fn clone(&self) -> Simulation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Simulation

fn default() -> Simulation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Simulation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Simulation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.