FsWeather Class Reference

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. More...
void	Save (string FileName)
	Saves the current weather settings to an XML file on the disk. More...

Static Public Member Functions
static FsWeather	FromXML (string XML)
	Creates a new instance of FsWeather from an XML string. More...
static FsWeather	Load (string FileName)
	Loads the weather settings from an XML file on the disk and creates a new instance of FsWeather. More...

Properties
string	Name [get, set]
	A name for this weather set. More...
string	Description [get, set]
	A long description of this weather. More...
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'. More...
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). More...
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). More...
double	ElevationMeters [get]
	When reading weather from a weather station this is the elevation of that station in Metres. More...
double	ElevationFeet [get]
	When reading weather from a weather station this is the elevation of that station in Feet. More...
uint	Timestamp [get]
	mSecs since start of the flight sim session. More...
FsPressure	Pressure [get, set]
	The current pressure values More...
FsVisibilityLayer	Visibility [get, set]
	The default (lowest) visibility layer More...
List< FsTemperatureLayer >	TemperatureLayers [get, set]
	The temperature layers (24 layers allowed) More...
List< FsWindLayer >	WindLayers [get, set]
	The wind layers (24 layers allowed) More...
List< FsCloudLayer >	CloudLayers [get, set]
	The cloud layers (16 layers allowed) More...
List< FsVisibilityLayer >	VisibilityUpperLayers [get, set]
	Upper visibility layers (12 upper layers allowed) More...

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.

See also Save() and FsWeather.Load()

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()

See also Save() and FsWeather.Load()

Returns

An XML string representing the setting for this weather object.

Property Documentation

CloudLayers

List<FsCloudLayer> CloudLayers

getset

The cloud layers (16 layers allowed)

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.

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.

ICAO

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'.

Latitude

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).

Longitude

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).

Name

string Name

getset

A name for this weather set.

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

Pressure

FsPressure Pressure

getset

The current pressure values

TemperatureLayers

List<FsTemperatureLayer> TemperatureLayers

getset

The temperature layers (24 layers allowed)

Timestamp

uint Timestamp

get

mSecs since start of the flight sim session.

Visibility

FsVisibilityLayer Visibility

getset

The default (lowest) visibility layer

VisibilityUpperLayers

List<FsVisibilityLayer> VisibilityUpperLayers

getset

Upper visibility layers (12 upper layers allowed)

WindLayers

List<FsWindLayer> WindLayers

getset

The wind layers (24 layers allowed)