Struct sim::SimOptions

pub struct SimOptions {
    pub run_name: String,
    pub use_freeform_policy_everywhere: bool,
    pub allow_block_the_box: bool,
    pub dont_recalc_lanechanging: bool,
    pub dont_break_turn_conflict_cycles: bool,
    pub dont_handle_uber_turns: bool,
    pub enable_pandemic_model: Option<XorShiftRng>,
    pub alerts: AlertHandler,
    pub infinite_parking: bool,
    pub disable_turn_conflicts: bool,
    pub skip_analytics: bool,
}

Options controlling the traffic simulation.

Fields

run_name: String

Used to distinguish savestates for running the same scenario.

use_freeform_policy_everywhere: bool

Ignore all stop signs and traffic signals, instead using a “freeform” policy to control access to intersections. If a requested turn doesn’t conflict with an already accepted one, immediately accept it. FIFO ordering, no balancing between different movements.

allow_block_the_box: bool

Allow a vehicle to start a turn, even if their target lane is already full. This may mean they’ll get stuck blocking the intersection.

dont_recalc_lanechanging: bool

Normally as a vehicle follows a route, it opportunistically make small changes to use a different lane, based on some score of “least-loaded” lane. Disable this default behavior.

dont_break_turn_conflict_cycles: bool

Normally if a cycle of vehicles depending on each other to turn is detected, temporarily allow “blocking the box” to try to break gridlock. Disable this default behavior.

dont_handle_uber_turns: bool

Disable experimental handling for “uber-turns”, sequences of turns through complex intersections with short roads. “Locks” the entire movement before starting, and ignores red lights after starting.

enable_pandemic_model: Option<XorShiftRng>

Enable an experimental SEIR pandemic model. This requires an RNG seed, which can be the same or different from the one used for the rest of the simulation.

alerts: AlertHandler

When a warning is encountered during simulation, specifies how to respond.

infinite_parking: bool

Ignore parking data in the map and instead treat every building as if it has unlimited capacity for vehicles.

Some maps always have this hardcoded on – see the code for the list.

disable_turn_conflicts: bool

Allow all agents to immediately proceed into an intersection, even if they’d hit another agent. Obviously this destroys realism of the simulation, but can be used to debug gridlock. Also implies freeform_policy, so vehicles ignore traffic signals.

skip_analytics: bool

Don’t collect any analytics. Only useful for benchmarking and debugging gridlock more quickly.

Implementations

impl SimOptions

pub fn new(run_name: &str) -> SimOptions

Trait Implementations

impl Clone for SimOptions

fn clone(&self) -> SimOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SimOptions

fn default() -> SimOptions

Returns the “default value” for a type.

impl StructOpt for SimOptions

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by [StructOpt::clap] called on the same type, otherwise it must panic.

fn from_args() -> Self

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Unlike [StructOpt::from_args], returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error>

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making.