A strongly-typed list of Airports. More...

Public Member Functions
	FsAirportCollection ()
	Creates a new, empty collection of FsAirport objects.

	FsAirportCollection (IEnumerable< FsAirport > Airports)
	Creates a new collection of FsAirport objects from another collection of FsAirports.

void	Add (FsAirport item)
	Adds an FsAirport object to this collection.

void	AddRange (IEnumerable< FsAirport > collection)
	Adds a collection of FsAirport objects to this collection.

void	Clear ()
	Clears the collection.

FsAirportCollection	FindAll (Predicate< FsAirport > Match)
	Gets a new list of airports that match the search criteria.

FsAirport	Find (Predicate< FsAirport > Match)
	Gets a new list of airports that match the search criteria.

FsAirportCollection	OrderBy< TKey > (Func< FsAirport, TKey > KeySelector)
	Gets a new list of airports ordered by the specified value.

FsAirportCollection	InRangeOfNauticalMiles (double DistanceNM)
	Gets a new list of airports that are within the specified distance. The list will be ordered by distance with the closest first.

FsAirportCollection	InRangeOfKilometres (double DistanceKM)
	Gets a new list of airports that are within the specified distance. The list will be ordered by distance with the closest first.

FsAirportCollection	WithRunway (Predicate< FsRunway > RunwayMatch)
	Gets a new list of airports that have at least one runway which matches the search criteria.

void	LoadComponents (AirportComponents Components)
	Loads the specified component data for the airports in this collection. (e.g. Runways, Taxiways etc).

void	LoadComponents (byte ClassInstance, AirportComponents Components)
	Loads the specified component data for the airports in this collection. (e.g. Runways, Taxiways etc).

void	SetReferenceLocation (AirportComponents Components)
	Sets the reference location (from where distance and bearing information is calculated), for all airports in the collection, to the current player position.

void	SetReferenceLocation (byte ClassInstance, AirportComponents Components)
	Sets the reference location (from where distance and bearing information is calculated), for all airports in the collection, to the current player position.

void	SetReferenceLocation (FsAirport Airport, AirportComponents Components)
	Sets the location from where distance and bearing information is calculated, for all airports in the collection.

void	SetReferenceLocation (string ICAO, AirportComponents Components)
	Sets the location from where distance and bearing information is calculated, for all airports in the collection.

void	SetReferenceLocation (byte ClassInstance, string ICAO, AirportComponents Components)
	Sets the location from where distance and bearing information is calculated, for all airports in the collection.

void	SetReferenceLocation (FsLatitude NewLatitude, FsLongitude NewLongitude, double MagVar, AirportComponents Components)
	Sets the location from where distance and bearing information is calculated, for all airports in the collection.

IEnumerator< FsAirport >	GetEnumerator ()
	Returns an enumerator that will enumerator through all the airports.

PlayerLocationInfo	GetPlayerLocation (AirportComponents Components)
	Returns an object containing information about the current player location. This includes database object like any airport or gates the player is at.

PlayerLocationInfo	GetPlayerLocation (byte ClassInstance, AirportComponents Components)
	Returns an object containing information about the current player location. This includes database object like any airport or gates the player is at.

Properties
FsAirport	this[string ICAO] `[get]`
	Gets a single airport using the IACO code. Must be in upper case.

FsAirport	this[int Index] `[get]`
	Gets a single airport using the index.

int	Count `[get]`
	Gets the number of airports in the collection.

Detailed Description

A strongly-typed list of Airports.

Member Function Documentation

◆ AddRange()

void AddRange ( IEnumerable< FsAirport > collection )

inline

Adds a collection of FsAirport objects to this collection.

Parameters

collection

◆ Find()

FsAirport Find ( Predicate< FsAirport > Match )

inline

Gets a new list of airports that match the search criteria.

Parameters

Match A delegate or Lambda expression that will test each runway.

Returns: The filtered collection of airports

◆ FindAll()

FsAirportCollection FindAll ( Predicate< FsAirport > Match )

inline

Gets a new list of airports that match the search criteria.

Parameters

Match A delegate or Lambda expression that will test each runway.

Returns: The filtered collection of airports

◆ GetPlayerLocation() [1/2]

PlayerLocationInfo GetPlayerLocation ( AirportComponents Components )

inline

Returns an object containing information about the current player location. This includes database object like any airport or gates the player is at.

Parameters

Components The components you want to process. e.g. if you want to know what gate the player is at you need to pass the Gate component.

If the requested components are not loaded for the Airport the player is at, they will be automatically loaded.

◆ GetPlayerLocation() [2/2]

PlayerLocationInfo GetPlayerLocation	(	byte	ClassInstance,
		AirportComponents	Components )

inline

Returns an object containing information about the current player location. This includes database object like any airport or gates the player is at.

Parameters

Components The components you want to process. e.g. if you want to know what gate the player is at you need to pass the Gate component.

If the requested components are not loaded for the Airport the player is at, they will be automatically loaded.

Parameters

ClassInstance The class instance of WideClient to connect to.

◆ InRangeOfKilometres()

FsAirportCollection InRangeOfKilometres ( double DistanceKM )

inline

Gets a new list of airports that are within the specified distance. The list will be ordered by distance with the closest first.

Parameters

DistanceKM The max distance for an airport to be included in Kilometres

Returns: The filtered collection of airports

◆ InRangeOfNauticalMiles()

FsAirportCollection InRangeOfNauticalMiles ( double DistanceNM )

inline

Gets a new list of airports that are within the specified distance. The list will be ordered by distance with the closest first.

Parameters

DistanceNM The max distance for an airport to be included in Nautical Miles

Returns: The filtered collection of airports

◆ LoadComponents() [1/2]

void LoadComponents ( AirportComponents Components )

inline

Loads the specified component data for the airports in this collection. (e.g. Runways, Taxiways etc).

If a component is already loaded it will not be loaded again

Parameters

Components The components to load. Combine flags using the bitwise or operator. ( '|' in C#, 'or' in VB.NET )

◆ LoadComponents() [2/2]

void LoadComponents	(	byte	ClassInstance,
		AirportComponents	Components )

inline

Loads the specified component data for the airports in this collection. (e.g. Runways, Taxiways etc).

If a component is already loaded it will not be loaded again

Parameters

Components	The components to load. Combine flags using the bitwise or operator. ( '\|' in C#, 'or' in VB.NET )
ClassInstance	The class instance of a WideClient.exe to connect to

◆ OrderBy< TKey >()

FsAirportCollection OrderBy< TKey > ( Func< FsAirport, TKey > KeySelector )

inline

Gets a new list of airports ordered by the specified value.

Parameters

KeySelector A delegate or Lambda expression specify the value to sort on.

Returns: The filtered collection of airports

◆ SetReferenceLocation() [1/6]

void SetReferenceLocation ( AirportComponents Components )

inline

Sets the reference location (from where distance and bearing information is calculated), for all airports in the collection, to the current player position.

Requires an open connection to FSUIPC

Note that no components will be loaded by this method. The components passed in only control what components are processed.

Parameters

Components The Components you want to apply the reference location to. Pass None to only apply to the airport.

◆ SetReferenceLocation() [2/6]

void SetReferenceLocation	(	byte	ClassInstance,
		AirportComponents	Components )

inline

Sets the reference location (from where distance and bearing information is calculated), for all airports in the collection, to the current player position.

Requires an open connection to FSUIPC

Note that no components will be loaded by this method. The components passed in only control what components are processed.

Parameters

ClassInstance	The ID of a specific class instance of WideClient
Components	The Components you want to apply the reference location to. Pass None to only apply to the airport.

◆ SetReferenceLocation() [3/6]

void SetReferenceLocation	(	byte	ClassInstance,
		string	ICAO,
		AirportComponents	Components )

inline

Sets the location from where distance and bearing information is calculated, for all airports in the collection.

Note that no components will be loaded by this method. The components passed in only control what components are processed.

Parameters

ICAO	The ICAO code of the airport to use as the reference location.
ClassInstance	The class instance of WideClient to connect to.
Components	The Components you want to apply the reference location to. Pass None to only apply to the airport.

◆ SetReferenceLocation() [4/6]

void SetReferenceLocation	(	FsAirport	Airport,
		AirportComponents	Components )

inline

Sets the location from where distance and bearing information is calculated, for all airports in the collection.

Note that no components will be loaded by this method. The components passed in only control what components are processed.

Parameters

Airport	The Airport to use as the reference location.
Components	The Components you want to apply the reference location to. Pass None to only apply to the airport.

◆ SetReferenceLocation() [5/6]

void SetReferenceLocation	(	FsLatitude	NewLatitude,
		FsLongitude	NewLongitude,
		double	MagVar,
		AirportComponents	Components )

inline

Sets the location from where distance and bearing information is calculated, for all airports in the collection.

Note that no components will be loaded by this method. The components passed in only control what components are processed.

Parameters

NewLatitude	The Latitude of the reference location
NewLongitude	The Longitude of the reference location
MagVar	The Magnetic Variation at the reference location
Components	The Components you want to apply the reference location to. Pass None to only apply to the airport.

◆ SetReferenceLocation() [6/6]

void SetReferenceLocation	(	string	ICAO,
		AirportComponents	Components )

inline

Sets the location from where distance and bearing information is calculated, for all airports in the collection.

Note that no components will be loaded by this method. The components passed in only control what components are processed.

Parameters

ICAO	The ICAO code of the airport to use as the reference location.
Components	The Components you want to apply the reference location to. Pass None to only apply to the airport.

◆ WithRunway()

FsAirportCollection WithRunway ( Predicate< FsRunway > RunwayMatch )

inline

Gets a new list of airports that have at least one runway which matches the search criteria.

The Runway data must have been loaded first

Parameters

RunwayMatch A delegate or Lambda expression that will test each runway.

Returns: The filtered collection of airports

Property Documentation

◆ this[int Index]

FsAirport this[int Index]

get

Gets a single airport using the index.

Parameters

Index The index of the airport to retrieve

◆ this[string ICAO]

FsAirport this[string ICAO]

get

Gets a single airport using the IACO code. Must be in upper case.

Parameters

ICAO	A string containing the ICAO code.

Returns

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddRange()

◆ Find()

◆ FindAll()

◆ GetPlayerLocation() [1/2]

◆ GetPlayerLocation() [2/2]

◆ InRangeOfKilometres()

◆ InRangeOfNauticalMiles()

◆ LoadComponents() [1/2]

◆ LoadComponents() [2/2]

◆ OrderBy< TKey >()

◆ SetReferenceLocation() [1/6]

◆ SetReferenceLocation() [2/6]

◆ SetReferenceLocation() [3/6]

◆ SetReferenceLocation() [4/6]

◆ SetReferenceLocation() [5/6]

◆ SetReferenceLocation() [6/6]

◆ WithRunway()

Property Documentation

◆ this[int Index]

◆ this[string ICAO]