WsfFuel

WsfFuel inherits WsfPlatformPart

WsfFuel encapsulates the ability to make queries regarding fuel status. This script can also add or subtract fuel from a platform.

Methods

string CurrentMode()

Return the name of the current fuel mode.

void SelectMode(string aMode)

Select the specified mode and make it the current mode.

bool Refuel()

bool Refuel(double aAmount)

Refuels the platform to its maximum fuel capacity. Returns ‘true’ if successful.

double QuantityRemaining()

Returns the quantity of fuel in kg remaining on the platform.

double QuantityRequired(double aDistance)

double QuantityRequired(double aDistance, double aAltitude, double aSpeed)

Returns the quantity of fuel in kg required to travel the given distance. If no altitude and speed are provided, the platform’s current altitude and speed are used.

double QuantityRequired(WsfRoute aRoute)

Returns the quantity of fuel in kg required to travel the given route. The altitude and speed of each waypoint in the route are used in the calculation.

void SetQuantityRemaining(double aQuantityRemaining)

Sets the remaining fuel quantity to the specified value (kg).

double ConsumptionRate()

double ConsumptionRate(double aAltitude, double aSpeed)

Returns the platform’s fuel consumption rate (kg/sec). If no altitude and speed are provided, the platform’s current altitude and speed are used.

void SetConsumptionRate(double aConsumptionRate)

Sets the fuel consumption rate to the specified value (kg/sec).

Warning

This method should only be used with the fixed consumption rate fuel model (i.e., not table driven).

double MaximumQuantity()

Returns the maximum fuel quantity (kg).

void SetMaximumQuantity(double aMaximumQuantity)

Sets the maximum fuel quantity to the specified value (kg).

double InitialQuantity()

Returns the initial fuel quantity (kg).

void SetInitialQuantity(double aInitialQuantity)

Sets the initial fuel quantity to the specified value (kg).

double BingoQuantity()

Returns the bingo fuel quantity (kg).

void SetBingoQuantity(double aBingoQuantity)

Sets the bingo fuel quantity to the specified value (kg).

double ReserveQuantity()

Returns the reserve fuel quantity (kg).

void SetReserveQuantity(double aReserveQuantity)

Sets the reserve fuel quantity to the specified value (kg).

double TimeAtBingo()

double TimeAtBingo(double aAltitude, double aSpeed)

Returns the time in seconds that the platform can travel after BINGO. If no altitude and speed are provided, the platform’s current altitude and speed are used.

double TimeAtReserve()

double TimeAtReserve(double aAltitude, double aSpeed)

Returns the time in seconds that the platform can travel after reserve limit. If no altitude and speed are provided, the platform’s current altitude and speed are used.

double TimeToBingo()

double TimeToBingo(double aAltitude, double aSpeed)

Returns the time in seconds until the platform will declare BINGO. If no altitude and speed are provided, the platform’s current altitude and speed are used.

double TimeToEmpty()

double TimeToEmpty(double aAltitude, double aSpeed)

Returns the time in seconds until the platform is completely out of fuel. If no altitude and speed are provided, the platform’s current altitude and speed are used.

double TimeToReserve()

double TimeToReserve(double aAltitude, double aSpeed)

Returns the time in seconds until the platform reaches its fuel reserve limit. If no altitude and speed are provided, the platform’s current altitude and speed are used.

double DistanceAtBingo()

double DistanceAtBingo(double aAltitude, double aSpeed)

Returns the distance in meters that the platform can travel after BINGO. If no altitude and speed are provided, the platform’s current altitude and speed are used.

double DistanceAtReserve()

double DistanceAtReserve(double aAltitude, double aSpeed)

Returns the distance in meters that the platform can travel after reserve limit. If no altitude and speed are provided, the platform’s current altitude and speed are used.

double DistanceToBingo()

double DistanceToBingo(double aAltitude, double aSpeed)

Returns the distance in meters until the platform will declare BINGO. If no altitude and speed are provided, the platform’s current altitude and speed are used.

double DistanceToReserve()

double DistanceToReserve(double aAltitude, double aSpeed)

Returns the distance in meters until the platform reaches its fuel reserve limit. If no altitude and speed are provided, the platform’s current altitude and speed are used.

double DistanceToEmpty()

double DistanceToEmpty(double aAltitude, double aSpeed)

Returns the distance in meters until the platform is completely out of fuel. If no altitude and speed are provided, the platform’s current altitude and speed are used.