OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.navigation.position_ui_if.PositionUiIf Class Reference

Display receiver position and the current complete satellite snapshot. More...

Inheritance diagram for ui.navigation.position_ui_if.PositionUiIf:
frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel ui.navigation.position_ui_stub.PositionUiStub

Public Member Functions

None set_position (self, PositionFix|None position_fix)
 Replace the current receiver position fix.
 
None set_satellites (self, Sequence[SatelliteInfo] satellites)
 Replace all currently displayed satellite information.
 

Detailed Description

Display receiver position and the current complete satellite snapshot.

None passed to set_position() means no position fix is available. An empty satellite sequence means no satellites are currently visible.

Member Function Documentation

◆ set_position()

None ui.navigation.position_ui_if.PositionUiIf.set_position (   self,
PositionFix | None  position_fix 
)

Replace the current receiver position fix.

Parameters
position_fixCurrent position fix, or None when unavailable.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.position_ui_stub.PositionUiStub.

◆ set_satellites()

None ui.navigation.position_ui_if.PositionUiIf.set_satellites (   self,
Sequence[SatelliteInfo]  satellites 
)

Replace all currently displayed satellite information.

Parameters
satellitesComplete current satellite collection.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.position_ui_stub.PositionUiStub.


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