OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf Class Reference

Display independently updated trip measurements in SI units. More...

Inheritance diagram for ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf:
apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel ui.automotive.vehicle_trip_ui_stub.VehicleTripUiStub

Public Member Functions

None set_odometer (self, float|None distance_m)
 Set the vehicle's lifetime distance.
 
None set_trip_distance (self, float|None distance_m)
 Set the current trip distance.
 
None set_estimated_range (self, float|None distance_m)
 Set the estimated remaining driving range.
 
None set_instantaneous_fuel_consumption (self, float|None fuel_consumption_m3_per_m)
 Set instantaneous fuel volume consumed per distance.
 
None set_average_fuel_consumption (self, float|None fuel_consumption_m3_per_m)
 Set average fuel volume consumed per distance.
 
None set_fuel_used (self, float|None fuel_volume_m3)
 Set fuel consumed during the current trip.
 

Detailed Description

Display independently updated trip measurements in SI units.

Member Function Documentation

◆ set_average_fuel_consumption()

None ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.set_average_fuel_consumption (   self,
float | None  fuel_consumption_m3_per_m 
)

Set average fuel volume consumed per distance.

Parameters
fuel_consumption_m3_per_mCubic metres per metre, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_trip_ui_stub.VehicleTripUiStub.

◆ set_estimated_range()

None ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.set_estimated_range (   self,
float | None  distance_m 
)

Set the estimated remaining driving range.

Parameters
distance_mEstimated range in metres, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_trip_ui_stub.VehicleTripUiStub.

◆ set_fuel_used()

None ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.set_fuel_used (   self,
float | None  fuel_volume_m3 
)

Set fuel consumed during the current trip.

Parameters
fuel_volume_m3Fuel volume in cubic metres, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_trip_ui_stub.VehicleTripUiStub.

◆ set_instantaneous_fuel_consumption()

None ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.set_instantaneous_fuel_consumption (   self,
float | None  fuel_consumption_m3_per_m 
)

Set instantaneous fuel volume consumed per distance.

Parameters
fuel_consumption_m3_per_mCubic metres per metre, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_trip_ui_stub.VehicleTripUiStub.

◆ set_odometer()

None ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.set_odometer (   self,
float | None  distance_m 
)

Set the vehicle's lifetime distance.

Parameters
distance_mLifetime distance in metres, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_trip_ui_stub.VehicleTripUiStub.

◆ set_trip_distance()

None ui.automotive.vehicle_trip_ui_if.VehicleTripUiIf.set_trip_distance (   self,
float | None  distance_m 
)

Set the current trip distance.

Parameters
distance_mTrip distance in metres, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_trip_ui_stub.VehicleTripUiStub.


The documentation for this class was generated from the following file: