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, Option<OffMapLocation>),
    PersonEntersMap(PersonID, AgentID, IntersectionID, Option<OffMapLocation>),
    PersonEntersRemoteBuilding(PersonID, OffMapLocation),
    PersonLeavesRemoteBuilding(PersonID, OffMapLocation),
    PedReachedParkingSpot(PedestrianID, ParkingSpot),
    BikeStoppedAtSidewalk(CarID, LaneID),
    AgentEntersTraversable(AgentID, Traversable, Option<usize>),
    IntersectionDelayMeasured(CompressedMovementID, Duration, AgentID),
    TripFinished {
        trip: TripID,
        mode: TripMode,
        total_time: Duration,
        blocked_time: Duration,
    },
    TripCancelled(TripID),
    TripPhaseStarting(TripID, PersonID, Option<PathRequest>, TripPhaseType),
    TripIntersectionDelay(TripID, TurnID, AgentID, Duration),
    LaneSpeedPercentage(TripID, LaneID, Speed, Speed),
    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)

CarLeftParkingSpot(CarID, ParkingSpot)

BusArrivedAtStop(CarID, BusRouteID, BusStopID)

BusDepartedFromStop(CarID, BusRouteID, BusStopID)

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

How long waiting at the stop?

PassengerAlightsTransit(PersonID, CarID, BusRouteID, BusStopID)

PersonEntersBuilding(PersonID, BuildingID)

PersonLeavesBuilding(PersonID, BuildingID)

PersonLeavesMap(PersonID, Option<AgentID>, IntersectionID, Option<OffMapLocation>)

None if cancelled

PersonEntersMap(PersonID, AgentID, IntersectionID, Option<OffMapLocation>)

PersonEntersRemoteBuilding(PersonID, OffMapLocation)

PersonLeavesRemoteBuilding(PersonID, OffMapLocation)

PedReachedParkingSpot(PedestrianID, ParkingSpot)

BikeStoppedAtSidewalk(CarID, LaneID)

AgentEntersTraversable(AgentID, Traversable, Option<usize>)

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

IntersectionDelayMeasured(CompressedMovementID, Duration, AgentID)

TripFinished

Fields of TripFinished

trip: TripIDmode: TripModetotal_time: Durationblocked_time: Duration

TripCancelled(TripID)

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

TripIntersectionDelay(TripID, TurnID, AgentID, Duration)

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

LaneSpeedPercentage(TripID, LaneID, Speed, Speed)

TripID, LaneID (Where the delay was encountered), Average Speed, Max Speed

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.

Alert(AlertLocation, 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