Editing SimTX API/Packets/WeatherMapRequest

{{SimTX API navigation}}
{{SimTX packet
| name = WeatherMapRequest
| frame = ClientFrame
| field = 33
| member = weather_map
| direction = c2s
| session = [[SimTX API/Control session|Control]]
| roles = <code>ROLE_CONTROL</code>.
| permission = None
| reply = [[SimTX API/Packets/WeatherMapResponse|WeatherMapResponse]]
| group = control
| file = control.proto
}}
'''WeatherMapRequest''' asks for a raster of the simulated tropospheric weather over an area. Tropospheric conditions, especially ducting, rain and cloud, affect VHF, UHF and microwave propagation.

== Definition ==
<syntaxhighlight lang="protobuf">
message WeatherMapRequest {
  int64 request_id = 1;
  double center_latitude_deg = 2;
  double center_longitude_deg = 3;
  double latitude_span_deg = 4;
  double longitude_span_deg = 5;
  int32 width = 6;
  int32 height = 7;
  string type = 8;             // weather type (string enum, common.proto)
}
</syntaxhighlight>

== Fields ==
{| class="wikitable"
! # !! Field !! Type !! Description
|-
| 1 || <code>request_id</code> || <code>int64</code> || Nonzero; echoed in the [[SimTX API/Packets/WeatherMapResponse|WeatherMapResponse]].
|-
| 2 || <code>center_latitude_deg</code> || <code>double</code> || Centre latitude, −90 to 90.
|-
| 3 || <code>center_longitude_deg</code> || <code>double</code> || Centre longitude, −180 to 180.
|-
| 4 || <code>latitude_span_deg</code> || <code>double</code> || Height of the area in degrees, greater than 0 and at most 180.
|-
| 5 || <code>longitude_span_deg</code> || <code>double</code> || Width of the area in degrees, greater than 0 and at most 360.
|-
| 6 || <code>width</code> || <code>int32</code> || Raster columns, 2 to 128.
|-
| 7 || <code>height</code> || <code>int32</code> || Raster rows, 2 to 64.
|-
| 8 || <code>type</code> || <code>string</code> || [[SimTX API/Data types#Weather type|Weather type]] to map.
|}

== Map types ==
{| class="wikitable"
! <code>type</code> !! Quantity !! Unit
|-
| <code>DUCT_STRENGTH</code> || Strength of the strongest tropospheric duct (drop in modified refractivity); 0 where there is none || M-units
|-
| <code>RAIN_RATE</code> || Rain rate || mm/h
|-
| <code>CLOUD_WATER</code> || Cloud liquid water content || g/m³
|-
| <code>SURFACE_TEMPERATURE</code> || Air temperature at the surface || °C
|-
| <code>LIGHTNING_RATE</code> || Lightning flash rate || flashes/min
|}

== Behaviour ==
Heavy request. Values outside the ranges in the field table are refused with [[SimTX API/Packets/Error|Error]] <code>INVALID_REQUEST</code>.

== See also ==
* [[SimTX API/Packets/WeatherMapResponse|WeatherMapResponse]]

{{SimTX API navbox}}
[[Category:SimTX API]]