Public Member Functions | Static Public Member Functions | Properties

FsLatitudeSpan Struct Reference

Represents a span of latitude in MS Flight Simulator. More...

List of all members.

Public Member Functions

 FsLatitudeSpan (double DecimalDegrees)
 Create a new latitude span represented by a number of degrees.
 FsLatitudeSpan (int Degrees, double DecimalMinutes)
 Create a new latitude span represented by a number of degrees and minutes.
 FsLatitudeSpan (int Degrees, int Minutes, double DecimalSeconds)
 Create a new latitude span represented by a number of degrees, minutes and seconds.
double ToFeet ()
 Gets the distance represented by the span in Feet.
double ToNauticalMiles ()
 Gets the distance represented by the span in Nautical Miles.
double ToMetres ()
 Gets the distance represented by the span in Metres.
override string ToString ()
 The span represented as a string in the default format of dd* mm.mmmm'.
string ToString (string DetailLevel, int DecimalPlaces)
 The span represented as a string in the specified format.

Static Public Member Functions

static FsLatitudeSpan FromFeet (double Feet)
 Create a new latitude span that represents a given distance in Feet.
static FsLatitudeSpan FromNauticalMiles (double NauticalMiles)
 Create a new latitude span that represents a given distance in Nautical Miles.
static FsLatitudeSpan FromMetres (double Metres)
 Create a new latitude span that represents a given distance in Metres.
static FsLatitudeSpan BetweenTwoLatitides (FsLatitude Lat1, FsLatitude Lat2)
 Create a new latitude span from two latitudes. The span will be the shortest absolute distance between them.

Properties

int Degrees [get]
 The number of whole degrees represented in the span.
int Minutes [get]
 The number of whole minutes represented in the span.
int Seconds [get]
 The number of whole seconds represented in the span.
double DecimalDegrees [get]
 The total number of degrees represented in the span.
double DecimalMinutes [get]
 The number of minutes represented in the span.
double DecimalSeconds [get]
 The number of seconds represented in the span.
double TotalMinutes [get]
 The value of the entire span represented in minutes.
double TotalSeconds [get]
 The value of the entire span represented in seconds.

Detailed Description

Represents a span of latitude in MS Flight Simulator.


Constructor & Destructor Documentation

FsLatitudeSpan ( double  DecimalDegrees )

Create a new latitude span represented by a number of degrees.

Parameters:
DecimalDegreesThe number of degrees for the span
FsLatitudeSpan ( int  Degrees,
double  DecimalMinutes 
)

Create a new latitude span represented by a number of degrees and minutes.

Parameters:
DegreesThe number of degrees for the span
DecimalMinutesThe number of minutes for the span
FsLatitudeSpan ( int  Degrees,
int  Minutes,
double  DecimalSeconds 
)

Create a new latitude span represented by a number of degrees, minutes and seconds.

Parameters:
DegreesThe number of degrees for the span
MinutesThe number of minutes for the span
DecimalSecondsThe number of seconds for the span

Member Function Documentation

static FsLatitudeSpan BetweenTwoLatitides ( FsLatitude  Lat1,
FsLatitude  Lat2 
) [static]

Create a new latitude span from two latitudes. The span will be the shortest absolute distance between them.

Parameters:
Lat1The Latitude at one end of the span
Lat2The Latitude at the other end of the span
Returns:
An FsLatitudeSpan representing the distance between the two latitudes in degrees
static FsLatitudeSpan FromFeet ( double  Feet ) [static]

Create a new latitude span that represents a given distance in Feet.

Parameters:
FeetThe number of Feet to convert to a latitude span
Returns:
An FsLatitudeSpan representing the number of feet in degrees latitude
static FsLatitudeSpan FromMetres ( double  Metres ) [static]

Create a new latitude span that represents a given distance in Metres.

Parameters:
MetresThe number of Metres to convert to a latitude span
Returns:
An FsLatitudeSpan representing the number of metres in degrees latitude
static FsLatitudeSpan FromNauticalMiles ( double  NauticalMiles ) [static]

Create a new latitude span that represents a given distance in Nautical Miles.

Parameters:
NauticalMilesThe number of Nautical Miles to convert to a latitude span
Returns:
An FsLatitudeSpan representing the number of Nautical Miles in degrees latitude
double ToFeet (  )

Gets the distance represented by the span in Feet.

double ToMetres (  )

Gets the distance represented by the span in Metres.

double ToNauticalMiles (  )

Gets the distance represented by the span in Nautical Miles.

override string ToString (  )

The span represented as a string in the default format of dd* mm.mmmm'.

Returns:
A string representing the latitude span in the default format
string ToString ( string  DetailLevel,
int  DecimalPlaces 
)

The span represented as a string in the specified format.

Parameters:
DetailLevelSpecifies the detail level. "d" for degrees only, "m" for degrees and minutes, "s" for degrees, minutes and seconds
DecimalPlacesThe number of decimal places to show
Returns:
A string representing the latitude span in the specified format

Property Documentation

double DecimalDegrees [get]

The total number of degrees represented in the span.

double DecimalMinutes [get]

The number of minutes represented in the span.

double DecimalSeconds [get]

The number of seconds represented in the span.

int Degrees [get]

The number of whole degrees represented in the span.

int Minutes [get]

The number of whole minutes represented in the span.

int Seconds [get]

The number of whole seconds represented in the span.

double TotalMinutes [get]

The value of the entire span represented in minutes.

double TotalSeconds [get]

The value of the entire span represented in seconds.