Interface TripDataListener

All Known Implementing Classes:
TripDataAdapter

public interface TripDataListener
Data listener for trip generators. This class is used for instrumenting a simulation.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    tripEnded(long tripID, double time, long ticks, Hub hub)
    Indicate that a trip has ended.
    void
    tripFailedAtStart(long tripID, double time, long ticks, Hub hub)
    Indicate that a trip has failed to start.
    void
    tripFailedMidstream(long tripID, double time, long ticks, Hub hub)
    Indicate that a trip has failed to complete.
    void
    tripPauseEnd(long tripID, double time, long ticks, Hub hub, HubDomain d)
    Indicates that the end of an interval during which a trip paused at an intermediate hub.
    void
    tripPauseStart(long tripID, double time, long ticks, Hub hub)
    Indicates that the start of an interval during which a trip paused at an intermediate hub.
    void
    tripStarted(long tripID, double time, long ticks, Hub hub, HubDomain d)
    Indicate that a trip has started.
  • Method Details

    • tripStarted

      void tripStarted(long tripID, double time, long ticks, Hub hub, HubDomain d)
      Indicate that a trip has started.
      Parameters:
      tripID - the ID for a trip;
      time - the simulation time in double-precision units
      ticks - the simulation time in ticks
      hub - the hub at which this event occurred
      d - the HubDomain that determined the travel time for the trip
    • tripPauseStart

      void tripPauseStart(long tripID, double time, long ticks, Hub hub)
      Indicates that the start of an interval during which a trip paused at an intermediate hub.
      Parameters:
      tripID - the ID for a trip;
      time - the simulation time in double-precision units
      ticks - the simulation time in ticks
      hub - the hub at which this event occurred
    • tripPauseEnd

      void tripPauseEnd(long tripID, double time, long ticks, Hub hub, HubDomain d)
      Indicates that the end of an interval during which a trip paused at an intermediate hub.
      Parameters:
      tripID - the ID for a trip;
      time - the simulation time in double-precision units
      ticks - the simulation time in ticks
      hub - the hub at which this event occurred
      d - the HubDomain that determined the travel time for the trip
    • tripEnded

      void tripEnded(long tripID, double time, long ticks, Hub hub)
      Indicate that a trip has ended.
      Parameters:
      tripID - the ID for a trip;
      time - the simulation time in double-precision units
      ticks - the simulation time in ticks
      hub - the hub at which this event occurred
    • tripFailedAtStart

      void tripFailedAtStart(long tripID, double time, long ticks, Hub hub)
      Indicate that a trip has failed to start. This can occur if a hub does not have a sufficient number of bicycles available.
      Parameters:
      tripID - the ID for a trip;
      time - the simulation time in double-precision units
      ticks - the simulation time in ticks
      hub - the hub at which this event occurred
    • tripFailedMidstream

      void tripFailedMidstream(long tripID, double time, long ticks, Hub hub)
      Indicate that a trip has failed to complete. This can occur if a hub does not have a sufficient number of bicycles available at an intermediate hop (e.g., for intermodal trips).

      Note: the class BasicTripGenerator does not call this method.

      Parameters:
      tripID - the ID for a trip;
      time - the simulation time in double-precision units
      ticks - the simulation time in ticks
      hub - the hub at which this event occurred