The main Weather object holding all the weather information. More...

Inherits FSUIPCStruct.

Public Member Functions
string	ToXML ()
	Converts this FsWeather instance into an XML string.

void	Save (string FileName)
	Saves the current weather settings to an XML file on the disk.

Static Public Member Functions
static FsWeather	FromXML (string XML)
	Creates a new instance of FsWeather from an XML string.

static FsWeather	Load (string FileName)
	Loads the weather settings from an XML file on the disk and creates a new instance of FsWeather.

Properties
string	Name `[get, set]`
	A name for this weather set.

string	Description `[get, set]`
	A long description of this weather.

string	ICAO `[get]`
	The ICAO code of the weather station from which the data has been retrieved. If global weather is requested this will be 'GLOB'.

FsLatitude	Latitude `[get]`
	The latitude of the current weather data (Will be 0 if the request was for Global weather or for an invalid ICAO code).

FsLongitude	Longitude `[get]`
	The longitude of the current weather data (Will be 0 if the request was for Global weather or for an invalid ICAO code).

double	ElevationMeters `[get]`
	When reading weather from a weather station this is the elevation of that station in Metres.

double	ElevationFeet `[get]`
	When reading weather from a weather station this is the elevation of that station in Feet.

uint	Timestamp `[get]`
	mSecs since start of the flight sim session.

FsPressure	Pressure `[get, set]`
	The current pressure values.

FsVisibilityLayer	Visibility `[get, set]`
	The default (lowest) visibility layer.

List< FsTemperatureLayer >	TemperatureLayers `[get, set]`
	The temperature layers (24 layers allowed)

List< FsWindLayer >	WindLayers `[get, set]`
	The wind layers (24 layers allowed)

List< FsCloudLayer >	CloudLayers `[get, set]`
	The cloud layers (16 layers allowed)

List< FsVisibilityLayer >	VisibilityUpperLayers `[get, set]`
	Upper visibility layers (12 upper layers allowed)

Detailed Description

The main Weather object holding all the weather information.

Member Function Documentation

◆ FromXML()

static FsWeather FromXML ( string XML )

inlinestatic

Creates a new instance of FsWeather from an XML string.

To generate the XML for an instance of FsWeather, use the ToXML() method on the object instance.

◆ Load()

static FsWeather Load ( string FileName )

inlinestatic

Loads the weather settings from an XML file on the disk and creates a new instance of FsWeather.

Use the Save() method on the FsWeather object to save the data to a file on the disk.

See also ToXML() and FsWeather.FromXML()

Parameters

FileName The full name and path of the file to load from.

◆ Save()

void Save ( string FileName )

inline

Saves the current weather settings to an XML file on the disk.

Use FsWeather.Load() to load the saved data.

See also ToXML() and FsWeather.FromXML()

Parameters

FileName The full name and path of the file to save to.

◆ ToXML()

string ToXML ( )

inline

Converts this FsWeather instance into an XML string.

This can be used by your application to save weather settings for future use. To create an FsWeather object from XML use FsWeather.FromXML()

Property Documentation

◆ Description

string Description

getset

A long description of this weather.

Can be used by applications that store and retrieve weather. Has nothing to do with the flight sim or FSUIPC.

◆ ElevationFeet

double ElevationFeet

get

When reading weather from a weather station this is the elevation of that station in Feet.

For weather at the aircraft location this is the elevation of the ground beneath the aircraft.

For weather at a specific Lat/Lon location this is always 0.

◆ ElevationMeters

double ElevationMeters

get

When reading weather from a weather station this is the elevation of that station in Metres.