nrel.hive.state.vehicle_state.dispatch_pooling_trip

Module Contents

Classes

DispatchPoolingTrip

Attributes

log

nrel.hive.state.vehicle_state.dispatch_pooling_trip.log[source]
class nrel.hive.state.vehicle_state.dispatch_pooling_trip.DispatchPoolingTrip[source]

Bases: nrel.hive.state.vehicle_state.vehicle_state.VehicleState

property vehicle_state_type: nrel.hive.state.vehicle_state.vehicle_state_type.VehicleStateType

unique state type, used for comparison, replaces need to call isinstance on the concrete VehicleState type (which leads to circular dependencies amongst VehicleStates) :return: the VehicleStateType of this VehicleState

vehicle_id: nrel.hive.util.typealiases.VehicleId
trip_plan: Tuple[Tuple[nrel.hive.util.typealiases.RequestId, nrel.hive.model.vehicle.trip_phase.TripPhase], Ellipsis]
route: nrel.hive.model.roadnetwork.route.Route
boarded_requests: immutables.Map[nrel.hive.util.typealiases.RequestId, nrel.hive.model.request.Request]
departure_times: immutables.Map[nrel.hive.util.typealiases.RequestId, nrel.hive.model.sim_time.SimTime]
num_passengers: int
instance_id: nrel.hive.state.vehicle_state.vehicle_state.VehicleStateInstanceId
classmethod build(vehicle_id: nrel.hive.util.typealiases.VehicleId, trip_plan: Tuple[Tuple[nrel.hive.util.typealiases.RequestId, nrel.hive.model.vehicle.trip_phase.TripPhase], Ellipsis], route: nrel.hive.model.roadnetwork.route.Route, boarded_requests: immutables.Map[nrel.hive.util.typealiases.RequestId, nrel.hive.model.request.Request] = immutables.Map(), departure_times: immutables.Map[nrel.hive.util.typealiases.RequestId, nrel.hive.model.sim_time.SimTime] = immutables.Map(), num_passengers: int = 0) → DispatchPoolingTrip[source]
update_route(route: nrel.hive.model.roadnetwork.route.Route) → DispatchPoolingTrip[source]
update(sim: nrel.hive.state.simulation_state.simulation_state.SimulationState, env: nrel.hive.runner.environment.Environment) → Tuple[Exception | None, nrel.hive.state.simulation_state.simulation_state.SimulationState | None][source]

apply any effects due to an entity being advanced one discrete time unit in this EntityState

Parameters:

  • sim – the simulation state

  • env – the simulation environment

Returns:

an exception due to failure or an optional updated simulation

enter(sim: nrel.hive.state.simulation_state.simulation_state.SimulationState, env: nrel.hive.runner.environment.Environment) → Tuple[Exception | None, nrel.hive.state.simulation_state.simulation_state.SimulationState | None][source]

checks that all requests exist. updates all requests to know that this vehicle is on it’s way

Parameters:

  • sim – the sim state

  • env – the sim environment

Returns:

an exception, or a sim state, or (None, None) if the request isn’t there anymore

exit(next_state: nrel.hive.state.vehicle_state.vehicle_state.VehicleState, sim: nrel.hive.state.simulation_state.simulation_state.SimulationState, env: nrel.hive.runner.environment.Environment) → Tuple[Exception | None, nrel.hive.state.simulation_state.simulation_state.SimulationState | None][source]

release the vehicle from the requests it was dispatched to

Parameters:

  • sim – the simulation state

  • env – the simulation environment

Returns:

an error, or, the updated simulation state, where the requests are no longer awaiting this vehicle

_has_reached_terminal_state_condition(sim: nrel.hive.state.simulation_state.simulation_state.SimulationState, env: nrel.hive.runner.environment.Environment) → bool[source]

this terminates when we reach a base

Parameters:

  • sim – the sim state

  • env – the sim environment

Returns:

True if we have reached the base

_default_terminal_state(sim: nrel.hive.state.simulation_state.simulation_state.SimulationState, env: nrel.hive.runner.environment.Environment) → Tuple[Exception | None, nrel.hive.state.vehicle_state.vehicle_state.VehicleState | None][source]

give the default state to transition to after having met a terminal condition

Parameters:

  • sim – the simulation state

  • env – the simulation environment

Returns:

an exception due to failure or the next_state after finishing a task

_perform_update(sim: nrel.hive.state.simulation_state.simulation_state.SimulationState, env: nrel.hive.runner.environment.Environment) → Tuple[Exception | None, nrel.hive.state.simulation_state.simulation_state.SimulationState | None][source]

take a step along the route to the first request

Parameters:

  • sim – the simulation state

  • env – the simulation environment

Returns:

the sim state with vehicle moved