Enum sim::events::Event

pub enum Event {
    CarReachedParkingSpot(CarID, ParkingSpot),
    CarLeftParkingSpot(CarID, ParkingSpot),
    BusArrivedAtStop(CarID, BusRouteID, BusStopID),
    BusDepartedFromStop(CarID, BusRouteID, BusStopID),
    PassengerBoardsTransit(PersonID, CarID, BusRouteID, BusStopID, Duration),
    PassengerAlightsTransit(PersonID, CarID, BusRouteID, BusStopID),
    PersonEntersBuilding(PersonID, BuildingID),
    PersonLeavesBuilding(PersonID, BuildingID),
    PersonLeavesMap(PersonID, Option<AgentID>, IntersectionID),
    PersonEntersMap(PersonID, AgentID, IntersectionID),
    PedReachedParkingSpot(PedestrianID, ParkingSpot),
    BikeStoppedAtSidewalk(CarID, LaneID),
    ProblemEncountered(TripID, Problem),
    AgentEntersTraversable(AgentID, Option<TripID>, Traversable, Option<usize>),
    IntersectionDelayMeasured(TripID, TurnID, AgentID, Duration),
    TripFinished {
        trip: TripID,
        mode: TripMode,
        total_time: Duration,
        blocked_time: Duration,
    },
    TripCancelled(TripID, TripMode),
    TripPhaseStarting(TripID, PersonID, Option<PathRequest>, TripPhaseType),
    PathAmended(Path),
    Alert(AlertLocation, String),
}

As a simulation runs, different systems emit Events. This cleanly separates the internal mechanics of the simulation from consumers that just want to know what’s happening.

An Event always occurs at a particular time, plumbed separately to consumers.

Many of these were created for a test framework that’s been abandoned. They could be removed or have their API adjusted, but it’s not urgent; publishing an event that’s not used by Analytics has no performance impact.

Variants

CarReachedParkingSpot(CarID, ParkingSpot)

Tuple Fields of CarReachedParkingSpot

0: CarID1: ParkingSpot

CarLeftParkingSpot(CarID, ParkingSpot)

Tuple Fields of CarLeftParkingSpot

0: CarID1: ParkingSpot

BusArrivedAtStop(CarID, BusRouteID, BusStopID)

Tuple Fields of BusArrivedAtStop

0: CarID1: BusRouteID2: BusStopID

BusDepartedFromStop(CarID, BusRouteID, BusStopID)

Tuple Fields of BusDepartedFromStop

0: CarID1: BusRouteID2: BusStopID

PassengerBoardsTransit(PersonID, CarID, BusRouteID, BusStopID, Duration)

How long waiting at the stop?

Tuple Fields of PassengerBoardsTransit

0: PersonID1: CarID2: BusRouteID3: BusStopID4: Duration

PassengerAlightsTransit(PersonID, CarID, BusRouteID, BusStopID)

Tuple Fields of PassengerAlightsTransit

0: PersonID1: CarID2: BusRouteID3: BusStopID

PersonEntersBuilding(PersonID, BuildingID)

Tuple Fields of PersonEntersBuilding

0: PersonID1: BuildingID

PersonLeavesBuilding(PersonID, BuildingID)

Tuple Fields of PersonLeavesBuilding

0: PersonID1: BuildingID

PersonLeavesMap(PersonID, Option<AgentID>, IntersectionID)

None if cancelled

Tuple Fields of PersonLeavesMap

0: PersonID1: Option<AgentID>2: IntersectionID

PersonEntersMap(PersonID, AgentID, IntersectionID)

Tuple Fields of PersonEntersMap

0: PersonID1: AgentID2: IntersectionID

PedReachedParkingSpot(PedestrianID, ParkingSpot)

Tuple Fields of PedReachedParkingSpot

0: PedestrianID1: ParkingSpot

BikeStoppedAtSidewalk(CarID, LaneID)

Tuple Fields of BikeStoppedAtSidewalk

0: CarID1: LaneID

ProblemEncountered(TripID, Problem)

Tuple Fields of ProblemEncountered

0: TripID1: Problem

AgentEntersTraversable(AgentID, Option<TripID>, Traversable, Option<usize>)

If the agent is a transit vehicle, then include a count of how many passengers are on board.

Tuple Fields of AgentEntersTraversable

0: AgentID1: Option<TripID>2: Traversable3: Option<usize>

IntersectionDelayMeasured(TripID, TurnID, AgentID, Duration)

TripID, TurnID (Where the delay was encountered), Time spent waiting at that turn

Tuple Fields of IntersectionDelayMeasured

0: TripID1: TurnID2: AgentID3: Duration

TripFinished

Fields of TripFinished

trip: TripIDmode: TripModetotal_time: Durationblocked_time: Duration

TripCancelled(TripID, TripMode)

Tuple Fields of TripCancelled

0: TripID1: TripMode

TripPhaseStarting(TripID, PersonID, Option<PathRequest>, TripPhaseType)

Tuple Fields of TripPhaseStarting

0: TripID1: PersonID2: Option<PathRequest>3: TripPhaseType

PathAmended(Path)

Just use for parking replanning. Not happy about copying the full path in here, but the way to plumb info into Analytics is Event.

Tuple Fields of PathAmended

0: Path

Alert(AlertLocation, String)

Tuple Fields of Alert

0: AlertLocation1: String

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Event> for Event

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

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

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

This method tests for !=.

impl Serialize for Event

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 Event