Enum sim::events::Event

pub enum Event {
    CarReachedParkingSpot(CarID, ParkingSpot),
    CarLeftParkingSpot(CarID, ParkingSpot),
    BusArrivedAtStop(CarID, TransitRouteID, TransitStopID),
    BusDepartedFromStop(CarID, TransitRouteID, TransitStopID),
    PassengerBoardsTransit(PersonID, CarID, TransitRouteID, TransitStopID, Duration),
    PassengerAlightsTransit(PersonID, CarID, TransitRouteID, TransitStopID),
    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

0: CarID

1: ParkingSpot

CarLeftParkingSpot(CarID, ParkingSpot)

Tuple Fields

0: CarID

1: ParkingSpot

BusArrivedAtStop(CarID, TransitRouteID, TransitStopID)

Tuple Fields

0: CarID

1: TransitRouteID

2: TransitStopID

BusDepartedFromStop(CarID, TransitRouteID, TransitStopID)

Tuple Fields

0: CarID

1: TransitRouteID

2: TransitStopID

PassengerBoardsTransit(PersonID, CarID, TransitRouteID, TransitStopID, Duration)

Tuple Fields

0: PersonID

1: CarID

2: TransitRouteID

3: TransitStopID

4: Duration

How long waiting at the stop?

PassengerAlightsTransit(PersonID, CarID, TransitRouteID, TransitStopID)

Tuple Fields

0: PersonID

1: CarID

2: TransitRouteID

3: TransitStopID

PersonEntersBuilding(PersonID, BuildingID)

Tuple Fields

0: PersonID

1: BuildingID

PersonLeavesBuilding(PersonID, BuildingID)

Tuple Fields

0: PersonID

1: BuildingID

PersonLeavesMap(PersonID, Option<AgentID>, IntersectionID)

Tuple Fields

0: PersonID

1: Option<AgentID>

2: IntersectionID

None if cancelled

PersonEntersMap(PersonID, AgentID, IntersectionID)

Tuple Fields

0: PersonID

1: AgentID

2: IntersectionID

PedReachedParkingSpot(PedestrianID, ParkingSpot)

Tuple Fields

0: PedestrianID

1: ParkingSpot

BikeStoppedAtSidewalk(CarID, LaneID)

Tuple Fields

0: CarID

1: LaneID

ProblemEncountered(TripID, Problem)

Tuple Fields

0: TripID

1: Problem

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

Tuple Fields

0: AgentID

1: Option<TripID>

2: Traversable

3: Option<usize>

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

IntersectionDelayMeasured(TripID, TurnID, AgentID, Duration)

Tuple Fields

0: TripID

1: TurnID

2: AgentID

3: Duration

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

TripFinished

Fields

trip: TripID

mode: TripMode

total_time: Duration

blocked_time: Duration

TripCancelled(TripID, TripMode)

Tuple Fields

0: TripID

1: TripMode

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

Tuple Fields

0: TripID

1: PersonID

2: Option<PathRequest>

3: TripPhaseType

PathAmended(Path)

Tuple Fields

0: 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.

Alert(AlertLocation, String)

Tuple Fields

0: AlertLocation

1: 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