OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.weather.weather_overlay_ui_if.WeatherOverlayUiIf Class Reference

Receive immutable SI weather state without providers or rendering commands. More...

Inheritance diagram for ui.weather.weather_overlay_ui_if.WeatherOverlayUiIf:
frontends.common.map_weather_overlay_ui.MapWeatherOverlayUi frontends.common.weather_overlay_ui_group.WeatherOverlayUiGroup ui.weather.weather_overlay_controls_if.WeatherOverlayControlsIf apps.orcUi.frontend.tk.navigation_route_weather.NavigationRouteWeather

Public Member Functions

None set_city_weather_state (self, CityWeatherOverlayState state)
 Present selected hourly city values.
 
None set_model_weather_state (self, ModelWeatherOverlayState state)
 Present a full-area forecast raster and SI legend.
 
None set_route_weather_state (self, RouteWeatherOverlayState state)
 Present weather at estimated route arrival times.
 

Detailed Description

Receive immutable SI weather state without providers or rendering commands.

Member Function Documentation

◆ set_city_weather_state()

None ui.weather.weather_overlay_ui_if.WeatherOverlayUiIf.set_city_weather_state (   self,
CityWeatherOverlayState  state 
)

Present selected hourly city values.

Parameters
stateComplete city overlay snapshot, with Kelvin, m/s or metres.

Reimplemented in apps.orcUi.frontend.tk.navigation_route_weather.NavigationRouteWeather, frontends.common.map_weather_overlay_ui.MapWeatherOverlayUi, and frontends.common.weather_overlay_ui_group.WeatherOverlayUiGroup.

◆ set_model_weather_state()

None ui.weather.weather_overlay_ui_if.WeatherOverlayUiIf.set_model_weather_state (   self,
ModelWeatherOverlayState  state 
)

Present a full-area forecast raster and SI legend.

Parameters
stateComplete model heatmap snapshot.

Reimplemented in apps.orcUi.frontend.tk.navigation_route_weather.NavigationRouteWeather, frontends.common.map_weather_overlay_ui.MapWeatherOverlayUi, and frontends.common.weather_overlay_ui_group.WeatherOverlayUiGroup.

◆ set_route_weather_state()

None ui.weather.weather_overlay_ui_if.WeatherOverlayUiIf.set_route_weather_state (   self,
RouteWeatherOverlayState  state 
)

Present weather at estimated route arrival times.

Parameters
stateComplete route checkpoint snapshot in SI units.

Reimplemented in apps.orcUi.frontend.tk.navigation_route_weather.NavigationRouteWeather, frontends.common.map_weather_overlay_ui.MapWeatherOverlayUi, and frontends.common.weather_overlay_ui_group.WeatherOverlayUiGroup.


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