OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.navigation.ground_track_ui_if.GroundTrackUiIf Class Reference

Display speed and actual direction of travel over the ground. More...

Inheritance diagram for ui.navigation.ground_track_ui_if.GroundTrackUiIf:
frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel ui.navigation.ground_track_ui_stub.GroundTrackUiStub

Public Member Functions

None set_ground_speed (self, float|None speed_mps)
 Set speed over ground.
 
None set_course_over_ground (self, float|None course_rad)
 Set actual direction of travel over the ground.
 

Detailed Description

Display speed and actual direction of travel over the ground.

Ground track is distinct from vehicle heading: a vehicle can point in one direction while moving in another. None means a measurement is unavailable.

Member Function Documentation

◆ set_course_over_ground()

None ui.navigation.ground_track_ui_if.GroundTrackUiIf.set_course_over_ground (   self,
float | None  course_rad 
)

Set actual direction of travel over the ground.

Parameters
course_radClockwise radians from true north, or None.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.ground_track_ui_stub.GroundTrackUiStub.

◆ set_ground_speed()

None ui.navigation.ground_track_ui_if.GroundTrackUiIf.set_ground_speed (   self,
float | None  speed_mps 
)

Set speed over ground.

Parameters
speed_mpsSpeed in metres per second, or None.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.ground_track_ui_stub.GroundTrackUiStub.


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