Struct map_model::objects::traffic_signals::ControlTrafficSignal

pub struct ControlTrafficSignal {
    pub id: IntersectionID,
    pub stages: Vec<Stage>,
    pub offset: Duration,
    pub movements: BTreeMap<MovementID, Movement>,
}

A traffic signal consists of a sequence of Stages that repeat in a cycle. Most Stages last for a fixed duration. During a single Stage, some movements are protected (can proceed with the highest priority), while others are permitted (have to yield before proceeding).

Fields

id: IntersectionID

stages: Vec<Stage>

offset: Duration

movements: BTreeMap<MovementID, Movement>

Implementations

impl ControlTrafficSignal

pub fn new(map: &Map, id: IntersectionID) -> ControlTrafficSignal

pub(crate) fn validating_new(
    map: &Map,
    id: IntersectionID
) -> ControlTrafficSignal

Only call this variant while importing the map, to enforce that baked-in signal config is valid.

pub fn get_possible_policies(
    map: &Map,
    id: IntersectionID
) -> Vec<(String, ControlTrafficSignal)>

pub fn get_min_crossing_time(&self, idx: usize) -> Duration

pub(crate) fn validate(&self) -> Result<()>

pub fn convert_to_ped_scramble(&mut self) -> bool

Move crosswalks from stages, adding them to an all-walk as last stage. This may promote yields to protected. True is returned if any stages were added or modified.

pub fn convert_to_ped_scramble_without_promotion(&mut self) -> bool

Move crosswalks from stages, adding them to an all-walk as last stage. This does not promote yields to protected. True is returned if any stages were added or modified.

fn internal_convert_to_ped_scramble(
    &mut self,
    promote_yield_to_protected: bool
) -> bool

pub fn adjust_major_minor_timing(
    &mut self,
    major: Duration,
    minor: Duration,
    map: &Map
) -> Result<()>

Modifies the fixed timing of all stages, applying either a major or minor duration, depending on the relative rank of the roads involved in the intersection. If this transformation couldn't be applied, returns an error. Even if an error is returned, the signal may have been changed -- so only call this on a cloned signal.

pub fn turn_to_movement(&self, turn: TurnID) -> MovementID

pub fn missing_turns(&self) -> BTreeSet<MovementID>

pub fn compressed_id(&self, turn: TurnID) -> CompressedMovementID

pub fn simple_cycle_duration(&self) -> Duration

How long a full cycle of the signal lasts, assuming no actuated timings.

impl ControlTrafficSignal

pub fn export(&self, map: &Map) -> TrafficSignal

pub(crate) fn import(
    raw: TrafficSignal,
    id: IntersectionID,
    map: &Map
) -> Result<ControlTrafficSignal>

Trait Implementations

impl Clone for ControlTrafficSignal

fn clone(&self) -> ControlTrafficSignal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ControlTrafficSignal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ControlTrafficSignal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<ControlTrafficSignal> for ControlTrafficSignal

fn eq(&self, other: &ControlTrafficSignal) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ControlTrafficSignal) -> bool

This method tests for !=.

impl Serialize for ControlTrafficSignal

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ControlTrafficSignal