OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
frontends.common.map_weather_overlay_ui.MapWeatherOverlayUi Class Reference

Translate SI weather state into renderer-specific GeoJSON and raster commands. More...

Inheritance diagram for frontends.common.map_weather_overlay_ui.MapWeatherOverlayUi:
ui.weather.weather_overlay_ui_if.WeatherOverlayUiIf

Public Member Functions

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

Detailed Description

Translate SI weather state into renderer-specific GeoJSON and raster commands.

Member Function Documentation

◆ set_city_weather_state()

frontends.common.map_weather_overlay_ui.MapWeatherOverlayUi.set_city_weather_state (   self,
  state 
)

Present selected hourly city values.

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

Reimplemented from ui.weather.weather_overlay_ui_if.WeatherOverlayUiIf.

◆ set_model_weather_state()

frontends.common.map_weather_overlay_ui.MapWeatherOverlayUi.set_model_weather_state (   self,
  state 
)

Present a full-area forecast raster and SI legend.

Parameters
stateComplete model heatmap snapshot.

Reimplemented from ui.weather.weather_overlay_ui_if.WeatherOverlayUiIf.

◆ set_route_weather_state()

frontends.common.map_weather_overlay_ui.MapWeatherOverlayUi.set_route_weather_state (   self,
  state 
)

Present weather at estimated route arrival times.

Parameters
stateComplete route checkpoint snapshot in SI units.

Reimplemented from ui.weather.weather_overlay_ui_if.WeatherOverlayUiIf.


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