WsfScriptFuelClass.cpp File Reference

#include "script/WsfScriptFuelClass.hpp"
#include "UtMemory.hpp"
#include "WsfFuel.hpp"
#include "script/WsfScriptContext.hpp"

Include dependency graph for WsfScriptFuelClass.cpp:

Functions
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, CurrentMode, 0, "string", "")
	string currentFuelMode = fuel.CurrentMode();
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, SelectMode, 1, "void", "string")
	fuel.SelectMode(string);
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, Refuel_1, 0, "bool", "")
	bool refueled = Refuel();
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, Refuel_2, 1, "bool", "double")
	bool refueled = Refuel(double aAmount);
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, QuantityRemaining, 0, "double", "")
	double quantityRemaining = QuantityRemaining();
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, QuantityRequired_1, 1, "double", "WsfRoute")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, QuantityRequired_2, 1, "double", "double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, QuantityRequired_3, 3, "double", "double, double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, SetQuantityRemaining, 1, "void", "double")
	SetQuantityRemaining(double);.
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, ConsumptionRate_1, 0, "double", "")
	double consumptionRate = ConsumptionRate();
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, ConsumptionRate_2, 2, "double", "double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, SetConsumptionRate, 1, "void", "double")
	SetConsumptionRate(double);.
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, MaximumQuantity, 0, "double", "")
	double maximumQuantity = GetMaximumQuantity();
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, SetMaximumQuantity, 1, "void", "double")
	SetMaxmimumQuantity(double);.
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, InitialQuantity, 0, "double", "")
	double initialQuantity = GetInitialQuantity();
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, SetInitialQuantity, 1, "void", "double")
	SetInitialQuantity(double);.
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, BingoQuantity, 0, "double", "")
	double bingoQuantity = BingoQuantity();
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, SetBingoQuantity, 1, "void", "double")
	SetBingoQuantity(double);.
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, ReserveQuantity, 0, "double", "")
	double reserveQuantity = ReserveQuantity();
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, SetReserveQuantity, 1, "void", "double")
	SetReserveQuantity(double);.
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, TimeAtBingo_1, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, TimeAtBingo_2, 2, "double", "double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, TimeAtReserve_1, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, TimeAtReserve_2, 2, "double", "double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, TimeToBingo_1, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, TimeToBingo_2, 2, "double", "double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, TimeToReserve_1, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, TimeToReserve_2, 2, "double", "double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, TimeToEmpty_1, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, TimeToEmpty_2, 2, "double", "double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, DistanceAtReserve_1, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, DistanceAtReserve_2, 2, "double", "double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, DistanceAtBingo_1, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, DistanceAtBingo_2, 2, "double", "double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, DistanceToReserve_1, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, DistanceToReserve_2, 2, "double", "double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, DistanceToBingo_1, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, DistanceToBingo_2, 2, "double", "double, double")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, DistanceToEmpty_1, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptFuelClass, WsfFuel, DistanceToEmpty_2, 2, "double", "double, double")

Function Documentation

UT_DEFINE_SCRIPT_METHOD() [1/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		BingoQuantity	,
		0	,
		"double"	,
		""	)

double bingoQuantity = BingoQuantity();

UT_DEFINE_SCRIPT_METHOD() [2/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		ConsumptionRate_1	,
		0	,
		"double"	,
		""	)

double consumptionRate = ConsumptionRate();

UT_DEFINE_SCRIPT_METHOD() [3/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		ConsumptionRate_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the consumption rate at the given altitude and speed double consumptionRate = ConsumptionRate(double altitude, double speed);

UT_DEFINE_SCRIPT_METHOD() [4/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		CurrentMode	,
		0	,
		"string"	,
		""	)

string currentFuelMode = fuel.CurrentMode();

UT_DEFINE_SCRIPT_METHOD() [5/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		DistanceAtBingo_1	,
		0	,
		"double"	,
		""	)

returns the distance after the fuel reaches the bingo amount at the given altitude and speed double distance_m = DistanceAtBingo();

References WsfFuel::ON_BINGO.

UT_DEFINE_SCRIPT_METHOD() [6/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		DistanceAtBingo_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the distance after the the fuel reaches the bingo amount at the given altitude and speed double distance_m = DistanceAtBingo(double altitude, double speed);

References WsfFuel::ON_BINGO.

UT_DEFINE_SCRIPT_METHOD() [7/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		DistanceAtReserve_1	,
		0	,
		"double"	,
		""	)

returns the distance after the fuel reaches the reserve amount at the given altitude and speed double distance_m = DistanceAtReserve();

References WsfFuel::ON_RESERVE.

UT_DEFINE_SCRIPT_METHOD() [8/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		DistanceAtReserve_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the distance after the the fuel reaches the reserve amount at the given altitude and speed double distance_m = DistanceAtReserve(double altitude, double speed);

References WsfFuel::ON_RESERVE.

UT_DEFINE_SCRIPT_METHOD() [9/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		DistanceToBingo_1	,
		0	,
		"double"	,
		""	)

returns the distance left until the fuel reaches the bingo amount at the given altitude and speed double distance_m = DistanceToBingo();

References WsfFuel::ON_BINGO.

UT_DEFINE_SCRIPT_METHOD() [10/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		DistanceToBingo_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the distance left until the the fuel reaches the bingo amount at the given altitude and speed double distance_m = DistanceToBingo(double altitude, double speed);

References WsfFuel::ON_BINGO.

UT_DEFINE_SCRIPT_METHOD() [11/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		DistanceToEmpty_1	,
		0	,
		"double"	,
		""	)

returns the distance left until the fuel is empty at the current altitude and speed double distance_m = DistanceToEmpty();

References WsfFuel::ON_EMPTY.

UT_DEFINE_SCRIPT_METHOD() [12/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		DistanceToEmpty_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the distance left until the fuel is empty at the given altitude and speed double distance_m = DistanceToEmpty(double altitude, double speed);

References WsfFuel::ON_EMPTY.

UT_DEFINE_SCRIPT_METHOD() [13/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		DistanceToReserve_1	,
		0	,
		"double"	,
		""	)

returns the distance left until the fuel reaches the reserve amount at the given altitude and speed double distance_m = DistanceToReserve();

References WsfFuel::ON_RESERVE.

UT_DEFINE_SCRIPT_METHOD() [14/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		DistanceToReserve_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the distance left until the the fuel reaches the reserve amount at the given altitude and speed double distance_m = DistanceToReserve(double altitude, double speed);

References WsfFuel::ON_RESERVE.

UT_DEFINE_SCRIPT_METHOD() [15/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		InitialQuantity	,
		0	,
		"double"	,
		""	)

double initialQuantity = GetInitialQuantity();

UT_DEFINE_SCRIPT_METHOD() [16/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		MaximumQuantity	,
		0	,
		"double"	,
		""	)

double maximumQuantity = GetMaximumQuantity();

UT_DEFINE_SCRIPT_METHOD() [17/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		QuantityRemaining	,
		0	,
		"double"	,
		""	)

double quantityRemaining = QuantityRemaining();

UT_DEFINE_SCRIPT_METHOD() [18/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		QuantityRequired_1	,
		1	,
		"double"	,
		"WsfRoute"	)

returns the amount of fuel required to complete the given route using the altitude and speed designated at each waypoint. double quantity = QuantityRequired(WsfRoute);

UT_DEFINE_SCRIPT_METHOD() [19/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		QuantityRequired_2	,
		1	,
		"double"	,
		"double"	)

returns the amount of fuel required to complete the given distance at the platform's current altitude and speed. double quantity = QuantityRequired(double distance);

UT_DEFINE_SCRIPT_METHOD() [20/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		QuantityRequired_3	,
		3	,
		"double"	,
		" double	,
		double	,
		double"	)

returns the amount of fuel required to complete the given distance at the given altitude and speed. double quantity = QuantityRequired(double distance, double alt, double speed);

UT_DEFINE_SCRIPT_METHOD() [21/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		Refuel_1	,
		0	,
		"bool"	,
		""	)

bool refueled = Refuel();

References WsfScriptContext::GetTIME_NOW(), and simTime.

UT_DEFINE_SCRIPT_METHOD() [22/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		Refuel_2	,
		1	,
		"bool"	,
		"double"	)

bool refueled = Refuel(double aAmount);

References WsfScriptContext::GetTIME_NOW(), and simTime.

UT_DEFINE_SCRIPT_METHOD() [23/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		ReserveQuantity	,
		0	,
		"double"	,
		""	)

double reserveQuantity = ReserveQuantity();

UT_DEFINE_SCRIPT_METHOD() [24/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		SelectMode	,
		1	,
		"void"	,
		"string"	)

fuel.SelectMode(string);

UT_DEFINE_SCRIPT_METHOD() [25/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		SetBingoQuantity	,
		1	,
		"void"	,
		"double"	)

SetBingoQuantity(double);.

UT_DEFINE_SCRIPT_METHOD() [26/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		SetConsumptionRate	,
		1	,
		"void"	,
		"double"	)

SetConsumptionRate(double);.

UT_DEFINE_SCRIPT_METHOD() [27/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		SetInitialQuantity	,
		1	,
		"void"	,
		"double"	)

SetInitialQuantity(double);.

UT_DEFINE_SCRIPT_METHOD() [28/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		SetMaximumQuantity	,
		1	,
		"void"	,
		"double"	)

SetMaxmimumQuantity(double);.

UT_DEFINE_SCRIPT_METHOD() [29/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		SetQuantityRemaining	,
		1	,
		"void"	,
		"double"	)

SetQuantityRemaining(double);.

UT_DEFINE_SCRIPT_METHOD() [30/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		SetReserveQuantity	,
		1	,
		"void"	,
		"double"	)

SetReserveQuantity(double);.

UT_DEFINE_SCRIPT_METHOD() [31/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		TimeAtBingo_1	,
		0	,
		"double"	,
		""	)

returns the amount of time after the fuel reaches the bingo amount at the current altitude and speed double timeToBingo = TimeAtBingo();

References WsfFuel::ON_BINGO.

UT_DEFINE_SCRIPT_METHOD() [32/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		TimeAtBingo_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the amount of time after the fuel reaches the bingo amount at the given altitude and speed double timeToBingo = TimeAtBingo(double altitude, double speed);

References WsfFuel::ON_BINGO.

UT_DEFINE_SCRIPT_METHOD() [33/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		TimeAtReserve_1	,
		0	,
		"double"	,
		""	)

returns the amount of time after the fuel reaches the reserve amount at the current altitude and speed double timeToReserve = TimeAtReserve();

References WsfFuel::ON_RESERVE.

UT_DEFINE_SCRIPT_METHOD() [34/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		TimeAtReserve_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the amount of time after the fuel reaches the reserve amount at the given altitude and speed double timeToReserve = TimeAtReserve(double altitude, double speed);

References WsfFuel::ON_RESERVE.

UT_DEFINE_SCRIPT_METHOD() [35/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		TimeToBingo_1	,
		0	,
		"double"	,
		""	)

returns the amount of time left until the fuel reaches the bingo amount at the current altitude and speed double timeToBingo = TimeToBingo();

References WsfFuel::ON_BINGO.

UT_DEFINE_SCRIPT_METHOD() [36/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		TimeToBingo_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the amount of time left until the fuel reaches the bingo amount at the given altitude and speed double timeToBingo = TimeToBingo(double altitude, double speed);

References WsfFuel::ON_BINGO.

UT_DEFINE_SCRIPT_METHOD() [37/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		TimeToEmpty_1	,
		0	,
		"double"	,
		""	)

returns the amount of time left until the fuel is empty at the current altitude and speed double timeToEmpty = TimeToEmpty();

References WsfFuel::ON_EMPTY.

UT_DEFINE_SCRIPT_METHOD() [38/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		TimeToEmpty_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the amount of time left until the fuel is empty at the given altitude and speed double timeToEmpty = TimeToEmpty(double altitude, double speed);

References WsfFuel::ON_EMPTY.

UT_DEFINE_SCRIPT_METHOD() [39/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		TimeToReserve_1	,
		0	,
		"double"	,
		""	)

returns the amount of time left until the fuel reaches the reserve amount at the current altitude and speed double timeToReserve = TimeToReserve();

References WsfFuel::ON_RESERVE.

UT_DEFINE_SCRIPT_METHOD() [40/40]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptFuelClass	,
		WsfFuel	,
		TimeToReserve_2	,
		2	,
		"double"	,
		" double	,
		double"	)

returns the amount of time left until the fuel reaches the reserve amount at the given altitude and speed double timeToReserve = TimeToReserve(double altitude, double speed);

References WsfFuel::ON_RESERVE.