ui.automotive.vehicle_ui_if.VehicleUiIf Class Reference

Display independently updated vehicle measurements. More...

Inheritance diagram for ui.automotive.vehicle_ui_if.VehicleUiIf:

Public Member Functions
None	set_gear (self, Gear|None gear)
	Set the currently engaged gear.
None	set_vehicle_speed (self, float|None speed_mps)
	Set vehicle speed.
None	set_engine_speed (self, float|None engine_speed_rad_s)
	Set engine angular speed.
None	set_fuel_level (self, float|None fuel_level_ratio)
	Set fuel level.
None	set_throttle_position (self, float|None throttle_position_ratio)
	Set throttle position.
None	set_accelerator_position (self, float|None accelerator_position_ratio)
	Set accelerator-pedal position.
None	set_engine_load (self, float|None engine_load_ratio)
	Set calculated engine load.
None	set_coolant_temperature (self, float|None coolant_temperature_k)
	Set engine coolant temperature.
None	set_intake_air_temperature (self, float|None intake_air_temperature_k)
	Set intake-air temperature.
None	set_manifold_pressure (self, float|None manifold_pressure_pa)
	Set manifold absolute pressure.
None	set_barometric_pressure (self, float|None barometric_pressure_pa)
	Set ambient barometric pressure.
None	set_boost_pressure (self, float|None boost_pressure_pa)
	Set boost pressure relative to atmosphere.
None	set_mass_air_flow (self, float|None mass_air_flow_kg_s)
	Set engine mass air flow.
None	set_control_voltage (self, float|None control_voltage_v)
	Set vehicle control-module voltage.
None	set_ambient_temperature (self, float|None ambient_temperature_k)
	Set the outside ambient temperature.
None	set_engine_oil_temperature (self, float|None engine_oil_temperature_k)
	Set the engine oil temperature.
None	set_engine_oil_pressure (self, float|None engine_oil_pressure_pa)
	Set the engine oil pressure.
None	set_transmission_temperature (self, float|None transmission_temperature_k)
	Set the transmission-fluid temperature.

Detailed Description

Display independently updated vehicle measurements.

Physical measurements use SI units. Dimensionless ratios use the inclusive range 0.0 through 1.0. None means an individual measurement is currently unavailable or unsupported. Implementations are responsible for converting values to the units selected by the user.

Member Function Documentation

set_accelerator_position()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_accelerator_position	(		self,
		float | None	accelerator_position_ratio
	)

Set accelerator-pedal position.

Parameters

accelerator_position_ratio

Position from 0.0 through 1.0, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_ambient_temperature()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_ambient_temperature	(		self,
		float | None	ambient_temperature_k
	)

Set the outside ambient temperature.

Parameters

ambient_temperature_k

Temperature in kelvin, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_barometric_pressure()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_barometric_pressure	(		self,
		float | None	barometric_pressure_pa
	)

Set ambient barometric pressure.

Parameters

barometric_pressure_pa

Pressure in pascals, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_boost_pressure()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_boost_pressure	(		self,
		float | None	boost_pressure_pa
	)

Set boost pressure relative to atmosphere.

Parameters

boost_pressure_pa

Relative pressure in pascals, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_control_voltage()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_control_voltage	(		self,
		float | None	control_voltage_v
	)

Set vehicle control-module voltage.

Parameters

control_voltage_v

Voltage in volts, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_coolant_temperature()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_coolant_temperature	(		self,
		float | None	coolant_temperature_k
	)

Set engine coolant temperature.

Parameters

coolant_temperature_k

Temperature in kelvin, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_engine_load()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_engine_load	(		self,
		float | None	engine_load_ratio
	)

Set calculated engine load.

Parameters

engine_load_ratio

Engine load from 0.0 through 1.0, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_engine_oil_pressure()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_engine_oil_pressure	(		self,
		float | None	engine_oil_pressure_pa
	)

Set the engine oil pressure.

Parameters

engine_oil_pressure_pa

Pressure in pascals, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_engine_oil_temperature()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_engine_oil_temperature	(		self,
		float | None	engine_oil_temperature_k
	)

Set the engine oil temperature.

Parameters

engine_oil_temperature_k

Temperature in kelvin, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_engine_speed()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_engine_speed	(		self,
		float | None	engine_speed_rad_s
	)

Set engine angular speed.

Parameters

engine_speed_rad_s

Engine speed in radians per second, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_fuel_level()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_fuel_level	(		self,
		float | None	fuel_level_ratio
	)

Set fuel level.

Parameters

fuel_level_ratio

Fuel level from 0.0 through 1.0, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_gear()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_gear	(		self,
		Gear | None	gear
	)

Set the currently engaged gear.

Parameters

gear	Current gear, or None when unavailable.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_intake_air_temperature()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_intake_air_temperature	(		self,
		float | None	intake_air_temperature_k
	)

Set intake-air temperature.

Parameters

intake_air_temperature_k

Temperature in kelvin, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_manifold_pressure()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_manifold_pressure	(		self,
		float | None	manifold_pressure_pa
	)

Set manifold absolute pressure.

Parameters

manifold_pressure_pa

Absolute pressure in pascals, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_mass_air_flow()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_mass_air_flow	(		self,
		float | None	mass_air_flow_kg_s
	)

Set engine mass air flow.

Parameters

mass_air_flow_kg_s

Mass flow in kilograms per second, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_throttle_position()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_throttle_position	(		self,
		float | None	throttle_position_ratio
	)

Set throttle position.

Parameters

throttle_position_ratio

Position from 0.0 through 1.0, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_transmission_temperature()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_transmission_temperature	(		self,
		float | None	transmission_temperature_k
	)

Set the transmission-fluid temperature.

Parameters

transmission_temperature_k

Temperature in kelvin, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

set_vehicle_speed()

None ui.automotive.vehicle_ui_if.VehicleUiIf.set_vehicle_speed	(		self,
		float | None	speed_mps
	)

Set vehicle speed.

Parameters

speed_mps

Vehicle speed in metres per second, or None.

Reimplemented in apps.demos.automotive.automotive_demo_ui.AutomotiveDemoUi, frontends.tk.automotive.vehicle_gauge_panel.VehicleGaugePanel, and ui.automotive.vehicle_ui_stub.VehicleUiStub.

---

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

• ui/automotive/vehicle_ui_if.py