nrel.hive.model.passenger

Module Contents

Classes

Passenger

A tuple representing a passenger in the simulation.

Functions

create_passenger_id(...)

Constructs a passenger id using a RequestId and an integer

board_vehicle(...)

updates each passenger with a vehicle_id
class nrel.hive.model.passenger.Passenger[source]

A tuple representing a passenger in the simulation.

Parameters:

  • id (PassengerId) – the unique id of the passenger

  • origin (GeoId) – the pickup location of the passenger

  • destination (GeoId) – the destination location of the passenger

  • departure_time (SimTime) – the departure time of the passenger

  • vehicle_id (Optional[VehicleId]) – id of the vehicle that the passenger is occupying

id: nrel.hive.util.typealiases.PassengerId
origin: nrel.hive.util.typealiases.GeoId
destination: nrel.hive.util.typealiases.GeoId
departure_time: nrel.hive.model.sim_time.SimTime
membership: nrel.hive.model.membership.Membership
vehicle_id: nrel.hive.util.typealiases.VehicleId | None
add_vehicle_id(vehicle_id: nrel.hive.util.typealiases.VehicleId) → Passenger[source]

Assign a VehicleId to a passenger

Parameters:

vehicle_id – vehicle id

Returns:

updated Passenger

nrel.hive.model.passenger.create_passenger_id(request_id: nrel.hive.util.typealiases.RequestId, passenger_id: int) → nrel.hive.util.typealiases.PassengerId[source]

Constructs a passenger id using a RequestId and an integer

Parameters:

  • request_id – request id

  • passenger_id – integer for passenger in a request.

Return type:

PassengerId

Returns:

a new unique PassengerId

nrel.hive.model.passenger.board_vehicle(passengers: nrel.hive.util.typealiases.Tuple[Passenger, Ellipsis], vehicle_id: nrel.hive.util.typealiases.VehicleId) → nrel.hive.util.typealiases.Tuple[Passenger, Ellipsis][source]

updates each passenger with a vehicle_id

Parameters:

  • passengers – the passengers to board

  • vehicle_id – the vehicle they are boarding

Returns:

the passengers with their vehicle_id updated