nrel.hive.reporting.vehicle_event_ops

Module Contents

Functions

vehicle_move_event(→ nrel.hive.reporting.reporter.Report)	creates a vehicle move report based on the effect of one time step of moving
vehicle_charge_event(→ nrel.hive.reporting.reporter.Report)	reports information about the marginal effect of a charge event
report_pickup_request(...)	reports information about the marginal effect of a request pickup
report_dropoff_request(...)	reports information about the marginal effect of a request dropoff from a ServicingTrip state
construct_station_load_events(...)	a station load report takes any vehicle charge events and attributes them to a

nrel.hive.reporting.vehicle_event_ops.vehicle_move_event(sim: nrel.hive.state.simulation_state.simulation_state.SimulationState, prev_vehicle: nrel.hive.model.vehicle.vehicle.Vehicle, next_vehicle: nrel.hive.model.vehicle.vehicle.Vehicle, route_traversal: nrel.hive.model.roadnetwork.routetraversal.RouteTraversal, env: nrel.hive.runner.environment.Environment) → nrel.hive.reporting.reporter.Report

creates a vehicle move report based on the effect of one time step of moving

Parameters:

• move_result – the result of a move

• env – the simulation environment

Returns:

the vehicle move report

nrel.hive.reporting.vehicle_event_ops.vehicle_charge_event(prev_vehicle: nrel.hive.model.vehicle.vehicle.Vehicle, next_vehicle: nrel.hive.model.vehicle.vehicle.Vehicle, next_sim: nrel.hive.state.simulation_state.simulation_state.SimulationState, station: nrel.hive.model.station.station.Station, charger: nrel.hive.model.energy.Charger, mechatronics: nrel.hive.model.vehicle.mechatronics.mechatronics_interface.MechatronicsInterface) → nrel.hive.reporting.reporter.Report

reports information about the marginal effect of a charge event

Parameters:

• prev_vehicle – the previous vehicle state

• next_vehicle – the next vehicle state

• next_sim – the next simulation state after the charge event

• station – the station involved with the charge event (either before or after update)

• charger – the charger used

• mechatronics – the vehicle mechatronics

Returns:

a charge event report

nrel.hive.reporting.vehicle_event_ops.report_pickup_request(vehicle: nrel.hive.model.vehicle.vehicle.Vehicle, request: nrel.hive.model.request.request.Request, next_sim: nrel.hive.state.simulation_state.simulation_state.SimulationState) → nrel.hive.reporting.reporter.Report

reports information about the marginal effect of a request pickup

Parameters:

• vehicle – the vehicle that picked up the request

• request – the request that was picked up

• next_sim – the next simulation state after the request pickup

Returns:

a pickup request report

nrel.hive.reporting.vehicle_event_ops.report_dropoff_request(vehicle: nrel.hive.model.vehicle.vehicle.Vehicle, sim: nrel.hive.state.simulation_state.simulation_state.SimulationState, request: nrel.hive.model.request.request.Request) → nrel.hive.reporting.reporter.Report

reports information about the marginal effect of a request dropoff from a ServicingTrip state which allows us to assume some ServicingTrip vehicle state properties.

Parameters:

• vehicle – the vehicle that picked up the request

• sim – simulation state when the dropoff occurs

• request – request for the trip that has completed

Returns:

a dropoff request report

nrel.hive.reporting.vehicle_event_ops.construct_station_load_events(reports: Tuple[nrel.hive.reporting.reporter.Report, Ellipsis], sim: nrel.hive.state.simulation_state.simulation_state.SimulationState) → Tuple[nrel.hive.reporting.reporter.Report, Ellipsis]

a station load report takes any vehicle charge events and attributes them to a station, so that, for each time step, we report the load of energy use at the station

Parameters:

• reports – the reports in this time step

• sim – the simulation state

Returns:

a collection with one STATION_LOAD_EVENT per StationId