#include <WsfFuel.hpp>

Inheritance diagram for WsfFuel:

[legend]

Collaboration diagram for WsfFuel:

[legend]

Public Types
enum	FuelState { ON_BINGO = 0 , ON_RESERVE = 1 , ON_EMPTY = 2 }
Public Types inherited from WsfPlatformPart
enum	{ cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using	InternalMessageQueue = std::queue<WsfMessage*>
using	RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart, WsfMessage>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.

Public Member Functions
	WsfFuel (WsfScenario &aScenario)
	~WsfFuel () override
WsfFuel *	Clone () const override
Public Member Functions inherited from WsfPlatformPart
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
unsigned int	GetDebugMask ()
bool	IsExternallyControlled () const
virtual void	SetExternallyControlled (double aSimTime, bool aIsExternallyControlled)
int	GetPartType () const
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
const WsfScenario &	GetScenario () const
WsfStringId	GetComponentName () const override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override
bool	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
WsfPlatform *	GetPlatform () const
virtual void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
virtual void	PlatformDeleted (WsfPlatform *aPlatformPtr)
double	GetLastStatusChangeTime () const
void	SetLastStatusChangeTime (double aSimTime)
	Allows a system to set the time at which the device was initialized.
bool	CanBeMadeOperational () const
	Returns an indication that this system can be made operational.
bool	CanBeMadeNonOperational () const
	Returns an indication that this system can be made non-operational.
bool	CanBeTurnedOn () const
	Returns an indication that this system can be turned on.
bool	CanBeTurnedOff () const
	Returns an indication that this system can be turned off.
bool	IsTurnedOn () const
bool	InitiallyTurnedOn () const
	Is the system to be turned 'on' when added to the simulation?
void	SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
	Sets if the system is turned on when added to the simulation.
virtual void	TurnOff (double aSimTime)
virtual void	TurnOn (double aSimTime)
virtual void	SetOperational (double aSimTime)
virtual void	SetNonOperational (double aSimTime)
virtual void	PartBroken (double aSimTime)
virtual void	Restore (double aSimTime)
bool	IsOperational () const
bool	SetOperational (double aSimTime, bool aMakeOperational)
double	GetDamageFactor () const
bool	SetDamageFactor (double aSimTime, double aDamageFactor)
bool	IsCritical () const
void	SetCritical (bool aValue)
virtual void	OnPlatformBrokenEvent (double aSimTime)
	Owning platform has issued a broken event.
bool	IsBroken () const
WsfInternalLinks &	GetInternalLinks ()
	Return the internal links for this part.
virtual bool	HasInternalLinks () const
	Does this platform part have a communication link to other platform parts?
virtual bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage)
virtual bool	ReceiveMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void	SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void	SendQueuedMessages (double aSimTime)
const WsfCategoryList &	GetCategories () const
	Get the categories to which this part belongs.
void	AddCategory (WsfStringId aCategoryId)
	Adds the provided category to the platform part's category list.
bool	IsCategoryMember (WsfStringId aCategoryId) const
const WsfGroupList &	GetGroups () const
	Get the groups to which this platform part belongs.
void	JoinGroup (WsfGroup *aGroupPtr)
	Join the given group.
void	LeaveGroup (WsfGroup *aGroupPtr)
	Leave the given group.
bool	IsGroupMember (WsfStringId aGroupId)
unsigned int	GetUpdateEventEpoch () const
void	IncrementUpdateEventEpoch ()
bool	UpdateEventActive () const
	Is an 'Update' event active?
void	SetUpdateEventActive (bool aUpdateEventActive)
	Indicate if the 'Update' event is active.
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual bool	PreInitialize (double aSimTime)
virtual void	PreInput ()
Public Member Functions inherited from WsfUniqueId
	WsfUniqueId ()
	Construtor initializes the unique identifier to 0.
	WsfUniqueId (const WsfUniqueId &)
	Copy constructor initializes the unique identifier to 0.
WsfUniqueId &	operator= (const WsfUniqueId &)
unsigned int	GetUniqueId () const
	Get the unique identifier assigned to this object.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept
Public Member Functions inherited from WsfSinglePlatformObserver
virtual	~WsfSinglePlatformObserver ()
virtual void	OnPlatformDeleting (double aSimTime, WsfPlatform *aPlatformPtr)
	Called before the platform is actually deleted.
virtual void	OnPlatformDeleted (double aSimTime, WsfPlatform *aPlatformPtr)
	Called just before the platform is removed from the simulation.

Fuel prediction methods
double	mLastUpdate
double	mReserveQuantity
double	mBingoQuantity
	Reserve fuel (defaults to 0).
double	FuelSecondsRemaining (const WsfRoute &aRoute)
double	FuelSeconds (const double aPounds)
double	FuelSeconds (const double aPounds, const double aSpeed, const double aAltitude)
double	TimeAt (FuelState aFuelState)
	Returns the time at the given fuel state based on the current consumption rate.
double	TimeAt (FuelState aFuelState, const double aSpeed, const double aAltitude)
	Returns the time at the given fuel state based on the consumption of the given altitude and speed.
double	TimeTo (FuelState aFuelState)
	Returns the time to the given fuel state based on the current consumption rate.
double	TimeTo (FuelState aFuelState, const double aAltitude, const double aSpeed)
	Returns the time to the given fuel state based on the consumption of the given altitude and speed.
double	DistanceAt (FuelState aFuelState)
	Returns the distance at the given fuel state based on the current consumption rate.
double	DistanceAt (FuelState aFuelState, const double aAltitude, const double aSpeed)
	Returns the distance at the given fuel state based on the consumption of the given altitude and speed.
double	DistanceTo (FuelState aFuelState)
	Returns the distance to the given fuel state based on the current consumption rate.
double	DistanceTo (FuelState aFuelState, const double aAltitude, const double aSpeed)
	Returns the distance to the given fuel state based on the consumption of the given altitude and speed.
bool	IsBingo () const
bool	IsOnReserve () const
bool	IsEmpty () const
virtual bool	Refuel (double aSimTime)
	Instantaneous refueling.
virtual bool	Refuel (double aSimTime, double aQuantity)
virtual WsfStringId	GetModeId () const
virtual std::string	GetMode () const
virtual void	SetMode (WsfStringId aMode)
void	SetMode (const std::string &aMode)
void	SetPlatform (WsfPlatform *aPlatformPtr) override
void	SetUpdateInterval (double aInterval) override
double	GetUpdateInterval () const override
double	GetLastUpdateTime () const
virtual double	CalcConsumptionRate ()
virtual double	CalcConsumptionRateAltitudeSpeed (const double aAltitude, const double aSpeed)
void	ExecuteEmptyScript (double aSimTime)
void	ExecuteReserveScript (double aSimTime)
void	ExecuteBingoScript (double aSimTime)
void	ExecuteRefuelScript (double aSimTime)
	WsfFuel (const WsfFuel &aSrc)
	Copy constructor (for Clone()).
WsfFuel &	operator= (const WsfFuel &aSrc)=delete
	Assignment constructor.
virtual double	CalculateDeltaQuantity (double aSimTime)
	Calculates a delta fuel quantity.
void	IncrementQuantity (double aDelta)
void	DecrementQuantity (double aDelta)
void	CheckEvents (double aSimTime)
void	ResetFlags ()

Component infrastructure methods not provided by WsfPlatformPart.
WsfComponent *	CloneComponent () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
int	GetComponentInitializationOrder () const override

Common infrastructure methods.
const char *	GetScriptClassName () const override

WsfPlatformPart methods.
bool	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	Update (double aSimTime) override

Overrides of WsfSinglePlatformObserver
void	OnPlatformUpdated (double aSimTime, WsfPlatform *aPlatformPtr) override
	Callback from platform when the mover is updated.

Fuel quantity accessor and mutators
virtual double	GetConsumptionRate ()
virtual double	GetConsumptionRate (const double aAltitude, const double aSpeed)
void	SetConsumptionRate (double aRate)
virtual double	GetSupplyRate () const
virtual double	GetReceiveRate () const
virtual double	GetNetDepletionRate ()
virtual double	GetNetDepletionRate (const double aAltitude, const double aSpeed)
virtual double	GetMaximumQuantity () const
virtual void	SetMaximumQuantity (double aQuantity)
virtual double	GetInitialQuantity () const
virtual void	SetInitialQuantity (double aQuantity)
virtual double	GetReserveQuantity () const
virtual void	SetReserveQuantity (double aQuantity)
double	GetBingoQuantity () const
void	SetBingoQuantity (double aQuantity)
virtual double	GetQuantityRemaining () const
virtual void	SetQuantityRemaining (double aQuantity)
virtual double	GetQuantityRequired (const WsfRoute &aRoute)
virtual double	GetQuantityRequired (const double aDistance)
virtual double	GetQuantityRequired (const double aDistance, const double aAltitude, const double aSpeed)

Additional Inherited Members
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
	WsfPlatformPart (const WsfPlatformPart &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void	AssignUniqueId (WsfSimulation *aSimulationPtr)

Detailed Description

A simple base class for fuel objects. The Reserve fuel value defaults to zero unless specified otherwise. Fuel quantity amounts Current, Bingo, Initial, and Maximum include Reserve.

Member Enumeration Documentation

◆ FuelState

enum WsfFuel::FuelState

Enumerator
ON_BINGO
ON_RESERVE
ON_EMPTY

Constructor & Destructor Documentation

◆ WsfFuel() [1/2]

WsfFuel::WsfFuel ( WsfScenario & aScenario )

References mBingoQuantity, mLastUpdate, mReserveQuantity, WsfObject::SetName(), WsfFuel(), and WsfPlatformPart::WsfPlatformPart().

Referenced by wsf::six_dof::Fuel::Clone(), WsfBrawlerFuel::Clone(), Clone(), WsfP6DOF_Fuel::Clone(), WsfTabularRateFuel::Clone(), WsfTankedFuel::Clone(), WsfVariableRateFuel::Clone(), wsf::six_dof::Fuel::Fuel(), wsf::six_dof::Fuel::Fuel(), wsf::six_dof::Fuel::operator=(), WsfBrawlerFuel::operator=(), operator=(), WsfP6DOF_Fuel::operator=(), WsfTabularRateFuel::operator=(), WsfTankedFuel::operator=(), WsfVariableRateFuel::operator=(), WsfBrawlerFuel::WsfBrawlerFuel(), WsfBrawlerFuel::WsfBrawlerFuel(), WsfFuel(), WsfFuel(), WsfP6DOF_Fuel::WsfP6DOF_Fuel(), WsfP6DOF_Fuel::WsfP6DOF_Fuel(), WsfTabularRateFuel::WsfTabularRateFuel(), WsfTabularRateFuel::WsfTabularRateFuel(), WsfVariableRateFuel::WsfVariableRateFuel(), and WsfVariableRateFuel::WsfVariableRateFuel().

◆ ~WsfFuel()

WsfFuel::~WsfFuel ( )

override

References WsfPlatform::DetachObserver(), and WsfPlatformPart::GetPlatform().

◆ WsfFuel() [2/2]

WsfFuel::WsfFuel ( const WsfFuel & aSrc )

protected

Copy constructor (for Clone()).

References mBingoQuantity, mLastUpdate, mReserveQuantity, WsfFuel(), and WsfPlatformPart::WsfPlatformPart().

Member Function Documentation

◆ CalcConsumptionRate()

double WsfFuel::CalcConsumptionRate ( )

protectedvirtual

Reimplemented in wsf::six_dof::Fuel, WsfBrawlerFuel, WsfP6DOF_Fuel, WsfTabularRateFuel, and WsfVariableRateFuel.

References GetConsumptionRate().

Referenced by WsfVariableRateFuel::CalcConsumptionRateAltitudeSpeed(), CalculateDeltaQuantity(), and GetNetDepletionRate().

◆ CalcConsumptionRateAltitudeSpeed()

double WsfFuel::CalcConsumptionRateAltitudeSpeed	(	const double	aAltitude,
		const double	aSpeed )

protectedvirtual

Reimplemented in wsf::six_dof::Fuel, WsfP6DOF_Fuel, WsfTabularRateFuel, and WsfVariableRateFuel.

References GetConsumptionRate().

Referenced by GetConsumptionRate(), and GetNetDepletionRate().

◆ CalculateDeltaQuantity()

double WsfFuel::CalculateDeltaQuantity ( double aSimTime )

protectedvirtual

Calculates a delta fuel quantity.

Parameters

aSimTime [input] The current simulation time.

Returns: A fuel quantity.

References CalcConsumptionRate(), and mLastUpdate.

Referenced by operator=(), and Update().

◆ CheckEvents()

void WsfFuel::CheckEvents ( double aSimTime )

protected

Executes a fuel object script if a fuel quantity has dropped below a threshold. (Transition is only valid when crossing from above to below a threshold value.)

Executes a fuel object script if a fuel quantity has dropped below a threshold.

Parameters

aSimTime [input] The current simulation time.

References ExecuteBingoScript(), ExecuteEmptyScript(), ExecuteReserveScript(), mBingoQuantity, and mReserveQuantity.

Referenced by WsfTankedFuel::DecrementQuantity(), operator=(), SetBingoQuantity(), SetReserveQuantity(), wsf::six_dof::Fuel::Update(), Update(), and WsfP6DOF_Fuel::Update().

◆ Clone()

WsfFuel * WsfFuel::Clone ( ) const

overridevirtual

Clone this object by creating an identical copy and returning a pointer to it.

Returns: A pointer to the cloned object.

Implements WsfObject.

Reimplemented in WsfP6DOF_Fuel, WsfTabularRateFuel, WsfTankedFuel, and WsfVariableRateFuel.

References WsfFuel().

◆ CloneComponent()

WsfComponent * WsfFuel::CloneComponent ( ) const

inlineoverridevirtual

Clones a component. May return null if component does not support clone.

Implements WsfComponent.

References WsfObject::Clone().

◆ DecrementQuantity()

void WsfFuel::DecrementQuantity ( double aDelta )

protected

References SetQuantityRemaining().

Referenced by WsfTankedFuel::DecrementQuantity(), operator=(), and Update().

◆ DistanceAt() [1/2]

double WsfFuel::DistanceAt ( FuelState aFuelState )

Returns the distance at the given fuel state based on the current consumption rate.

Gets the distance at the given fuel state based on the current consumption rate.

Parameters

aFuelState [input] The fuel state to check.

Returns: Distance in meters to the given fuel state.

References DistanceAt(), WsfPlatformPart::GetPlatform(), and platformPtr.

Referenced by DistanceAt().

◆ DistanceAt() [2/2]

double WsfFuel::DistanceAt	(	FuelState	aFuelState,
		const double	aAltitude,
		const double	aSpeed )

Returns the distance at the given fuel state based on the consumption of the given altitude and speed.

Gets the distance at the given fuel state based on the consumption rate at the given altitude and speed.

Parameters

aFuelState	[input] The fuel state to check.
aAltitude	[input] The desired altitude
aSpeed	[input] The desired speed

Returns: Distance in meters to the given fuel state.

References TimeAt().

◆ DistanceTo() [1/2]

double WsfFuel::DistanceTo ( FuelState aFuelState )

Returns the distance to the given fuel state based on the current consumption rate.

Gets the distance to the given fuel state based on the current consumption rate.

Parameters

aFuelState [input] The fuel state to check.

Returns: Distance in meters to the given fuel state.

References DistanceTo(), WsfPlatformPart::GetPlatform(), and platformPtr.

Referenced by DistanceTo().

◆ DistanceTo() [2/2]

double WsfFuel::DistanceTo	(	FuelState	aFuelState,
		const double	aAltitude,
		const double	aSpeed )

Returns the distance to the given fuel state based on the consumption of the given altitude and speed.

Gets the distance to the given fuel state based on the consumption rate at the given altitude and speed.

Parameters

aFuelState	[input] The fuel state to check.
aAltitude	[input] The desired altitude
aSpeed	[input] The desired speed

Returns: Distance in meters to the given fuel state.

References TimeTo().

◆ ExecuteBingoScript()

void WsfFuel::ExecuteBingoScript ( double aSimTime )

protected

References WsfObserver::FuelEvent(), and WsfPlatformPart::GetSimulation().

Referenced by CheckEvents().

◆ ExecuteEmptyScript()

void WsfFuel::ExecuteEmptyScript ( double aSimTime )

protected

References WsfObserver::FuelEvent(), and WsfPlatformPart::GetSimulation().

Referenced by CheckEvents().

◆ ExecuteRefuelScript()

void WsfFuel::ExecuteRefuelScript ( double aSimTime )

protected

References WsfObserver::FuelEvent(), and WsfPlatformPart::GetSimulation().

Referenced by Refuel(), and Refuel().

◆ ExecuteReserveScript()

void WsfFuel::ExecuteReserveScript ( double aSimTime )

protected

References WsfObserver::FuelEvent(), and WsfPlatformPart::GetSimulation().

Referenced by CheckEvents().

◆ FuelSeconds() [1/2]

double WsfFuel::FuelSeconds ( const double aPounds )

Gets the number of seconds of fuel represented by a given number of pounds of fuel.

Parameters

aPounds [input] The fuel quantity in pounds (lbs) to use for calculation

Returns: Time in seconds of how long aPounds fuel will last

References FuelSeconds(), WsfPlatformPart::GetPlatform(), and platformPtr.

Referenced by FuelSeconds().

◆ FuelSeconds() [2/2]

double WsfFuel::FuelSeconds	(	const double	aPounds,
		const double	aSpeed,
		const double	aAltitude )

Gets the number of seconds of fuel represented by a given number of pounds of fuel.

Parameters

aPounds	[input] The fuel quantity in pounds (lbs) to use for calculation
aSpeed	[input] The speed to use for calculation
aAltitude	[input] The altitude to use for calculation

Returns: Time in seconds of how long aPounds fuel will last

References GetConsumptionRate().

◆ FuelSecondsRemaining()

double WsfFuel::FuelSecondsRemaining ( const WsfRoute & aRoute )

Gets the number of seconds of fuel remaining after flying aRoute.

Parameters

aRoute [input] The route to use for calculation

Returns: Time in seconds of total fuel remaining

References GetConsumptionRate(), and WsfRoute::GetTravelTime().

◆ GetBingoQuantity()

double WsfFuel::GetBingoQuantity ( ) const

inline

References mBingoQuantity.

Referenced by WsfTankedFuel::DecrementQuantity(), and WsfTankedFuel::ProcessInput().

◆ GetComponentInitializationOrder()

int WsfFuel::GetComponentInitializationOrder ( ) const

inlineoverridevirtual

Forces a specific initialization order. Components are initialized in increasing initialization order value.

Reimplemented from WsfComponent.

References cWSF_INITIALIZE_ORDER_FUEL.

◆ GetComponentRoles()

const int * WsfFuel::GetComponentRoles ( ) const

overridevirtual

Returns a zero-terminated array of component roles. Note that the array should be in decreasing order of specificity and should generally the inheritance hierarchy. The first entry should be the components 'primary' role. For example a sensor would do the following:

static const int roles[] = { cWSF_COMPONENT_SENSOR, cWSF_COMPONENT_ARTICULATED_PART,
                             cWSF_COMPONENT_PLATFORM_PART, 0 };
return roles;

Implements WsfComponent.

References cWSF_COMPONENT_FUEL, cWSF_COMPONENT_NULL, and cWSF_COMPONENT_PLATFORM_PART.

◆ GetConsumptionRate() [1/2]

virtual double WsfFuel::GetConsumptionRate ( )

inlinevirtual

Reimplemented in wsf::six_dof::Fuel, and WsfP6DOF_Fuel.

Referenced by CalcConsumptionRate(), CalcConsumptionRateAltitudeSpeed(), FuelSeconds(), FuelSecondsRemaining(), GetQuantityRequired(), and TimeAt().

◆ GetConsumptionRate() [2/2]

double WsfFuel::GetConsumptionRate	(	const double	aAltitude,
		const double	aSpeed )

virtual

Reimplemented in wsf::six_dof::Fuel, and WsfP6DOF_Fuel.

References CalcConsumptionRateAltitudeSpeed().

◆ GetInitialQuantity()

virtual double WsfFuel::GetInitialQuantity ( ) const

inlinevirtual

Referenced by WsfBrawlerFuel::Initialize(), wsf::six_dof::Fuel::Initialize2(), and WsfP6DOF_Fuel::Initialize2().

◆ GetLastUpdateTime()

double WsfFuel::GetLastUpdateTime ( ) const

inlineprotected

References mLastUpdate.

Referenced by wsf::six_dof::Fuel::Update(), WsfP6DOF_Fuel::Update(), and WsfTankedFuel::Update().

◆ GetMaximumQuantity()

virtual double WsfFuel::GetMaximumQuantity ( ) const

inlinevirtual

Referenced by WsfTankedFuel::IncrementQuantity(), WsfExchange::Transactor::Initialize(), WsfTankedFuel::Initialize(), and WsfTankedFuel::ProcessInput().

◆ GetMode()

std::string WsfFuel::GetMode ( ) const

virtual

Referenced by WsfTabularRateFuel::CalcConsumptionRate(), WsfTabularRateFuel::CalcConsumptionRateAltitudeSpeed(), WsfVariableRateFuel::CalcConsumptionRateAltitudeSpeed(), and WsfVariableRateFuel::Initialize().

◆ GetModeId()

virtual WsfStringId WsfFuel::GetModeId ( ) const

inlinevirtual

Referenced by WsfTabularRateFuel::GetCurrentTable().

◆ GetNetDepletionRate() [1/2]

double WsfFuel::GetNetDepletionRate ( )

virtual

References CalcConsumptionRate(), GetReceiveRate(), and GetSupplyRate().

Referenced by TimeTo().

◆ GetNetDepletionRate() [2/2]

double WsfFuel::GetNetDepletionRate	(	const double	aAltitude,
		const double	aSpeed )

virtual

References CalcConsumptionRateAltitudeSpeed(), GetReceiveRate(), and GetSupplyRate().

◆ GetQuantityRemaining()

virtual double WsfFuel::GetQuantityRemaining ( ) const

inlinevirtual

Reimplemented in wsf::six_dof::Fuel, and WsfP6DOF_Fuel.

Referenced by WsfTankedFuel::BeginSupplyingFuelTo(), WsfTankedFuel::DecrementQuantity(), WsfTankedFuel::IncrementQuantity(), and WsfTankedFuel::Initialize().

◆ GetQuantityRequired() [1/3]

double WsfFuel::GetQuantityRequired ( const double aDistance )

virtual

Returns the amount of fuel that will be expended if the platform traveled the given distance at it's current altitude and speed.

Parameters

aDistance [input] The desired distance

References WsfPlatformPart::GetPlatform(), and GetQuantityRequired().

◆ GetQuantityRequired() [2/3]

double WsfFuel::GetQuantityRequired	(	const double	aDistance,
		const double	aAltitude,
		const double	aSpeed )

virtual

Returns the amount of fuel that will be expended if the platform traveled the given distance at the given altitude and speed.

Parameters

aDistance	[input] The desired distance
aAltitude	[input] The desired altitude
aSpeed	[input] The desired speed

References GetConsumptionRate().

◆ GetQuantityRequired() [3/3]

double WsfFuel::GetQuantityRequired ( const WsfRoute & aRoute )

virtual

Returns the amount of fuel that will be expended if the platform traveled the given route at the altitude and speed designated by each waypoint.

Parameters

aRoute [input] The Desired Route.

References WsfRoute::GetDistance(), GetQuantityRequired(), and WsfRoute::GetWaypoints().

Referenced by GetQuantityRequired(), and GetQuantityRequired().

◆ GetReceiveRate()

virtual double WsfFuel::GetReceiveRate ( ) const

inlinevirtual

Reimplemented in WsfTankedFuel.

Referenced by GetNetDepletionRate(), and GetNetDepletionRate().

◆ GetReserveQuantity()

virtual double WsfFuel::GetReserveQuantity ( ) const

inlinevirtual

References mReserveQuantity.

Referenced by WsfTankedFuel::BeginSupplyingFuelTo(), and WsfTankedFuel::DecrementQuantity().

◆ GetScriptClassName()

const char * WsfFuel::GetScriptClassName ( ) const

override

◆ GetSupplyRate()

virtual double WsfFuel::GetSupplyRate ( ) const

inlinevirtual

Reimplemented in WsfTankedFuel.

Referenced by GetNetDepletionRate(), and GetNetDepletionRate().

◆ GetUpdateInterval()

double WsfFuel::GetUpdateInterval ( ) const

inlineoverrideprotectedvirtual

Get interval at which Update() is called. This value is set by calling WsfSimulation::GetInstance().SetProcessorUpdateInterval();

Implements WsfPlatformPart.

◆ IncrementQuantity()

void WsfFuel::IncrementQuantity ( double aDelta )

protected

References SetQuantityRemaining().

Referenced by WsfTankedFuel::IncrementQuantity(), and operator=().

◆ Initialize()

bool WsfFuel::Initialize ( double aSimTime )

overridevirtual

Initialize the fuel object.

Parameters

aSimTime [input] The current simulation time.

Returns: 'true' if the object was successfully initialized or 'false' if initialization failed.

Reimplemented from WsfComponent.

Reimplemented in WsfTabularRateFuel, WsfTankedFuel, and WsfVariableRateFuel.

References WsfPlatform::AttachObserver(), WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::Initialize(), mLastUpdate, ok, ResetFlags(), and SetQuantityRemaining().

Referenced by WsfBrawlerFuel::Initialize(), WsfTabularRateFuel::Initialize(), and WsfVariableRateFuel::Initialize().

◆ Initialize2()

bool WsfFuel::Initialize2 ( double aSimTime )

overridevirtual

Perform phase 2 initialization. This is called by WsfPlatform::Initialize() during phase 2 of platform initialization. This method is typically used when a component may have some dependency on another component having completed its phase 1 initialization. The component should be ready for use in the simulation upon completion of this method.

The order in which components are initialized is defined by GetComponentInitializationOrder.

Parameters

aSimTime The current simulation time.

Returns: true if successful or false if unsuccessful.

Note: This method MUST NOT add any other components to the platform. This MUST be done in PreInitialize().

Reimplemented from WsfComponent.

Reimplemented in WsfP6DOF_Fuel.

References WsfPlatformPart::Initialize2(), and ok.

Referenced by wsf::six_dof::Fuel::Initialize2(), WsfBrawlerFuel::Initialize2(), and WsfP6DOF_Fuel::Initialize2().

◆ IsBingo()

bool WsfFuel::IsBingo ( ) const

inline

Referenced by WsfTankedFuel::BeginSupplyingFuelTo(), WsfTankedFuel::DecrementQuantity(), and WsfTankedFuel::UpdateFuelingOps().

◆ IsEmpty()

bool WsfFuel::IsEmpty ( ) const

inline

Referenced by WsfTankedFuel::UpdateFuelingOps().

◆ IsOnReserve()

bool WsfFuel::IsOnReserve ( ) const

inline

Referenced by WsfTankedFuel::DecrementQuantity(), and WsfTankedFuel::UpdateFuelingOps().

◆ OnPlatformUpdated()

void WsfFuel::OnPlatformUpdated	(	double	aSimTime,
		WsfPlatform *	aPlatformPtr )

overridevirtual

Callback from platform when the mover is updated.

Reimplemented from WsfSinglePlatformObserver.

References Update().

◆ operator=()

WsfFuel & WsfFuel::operator= ( const WsfFuel & aSrc )

protecteddelete

Assignment constructor.

References CalculateDeltaQuantity(), CheckEvents(), DecrementQuantity(), IncrementQuantity(), ResetFlags(), and WsfFuel().

◆ ProcessInput()

bool WsfFuel::ProcessInput ( UtInput & aInput )

overridevirtual

Process the fuel object block.

Parameters

aInput [input] The input stream.

Returns: 'true' if the command was recognized (and processed) or 'false' if the command was not one recognized by this class.

Reimplemented from WsfObject.

Reimplemented in WsfP6DOF_Fuel, WsfTabularRateFuel, WsfTankedFuel, and WsfVariableRateFuel.

References mBingoQuantity, mReserveQuantity, and WsfPlatformPart::ProcessInput().

Referenced by wsf::six_dof::Fuel::ProcessInput(), WsfBrawlerFuel::ProcessInput(), WsfP6DOF_Fuel::ProcessInput(), WsfTabularRateFuel::ProcessInput(), and WsfVariableRateFuel::ProcessInput().

◆ QueryInterface()

void * WsfFuel::QueryInterface ( int aRole )

overridevirtual

Requests a component's role interface. A component can support one or more roles.

Parameters

aRole The role whose interface is to be returned.

Returns: A pointer to the object if it supports the indicated role, or 'null' if it does not. Usage: WsfProcessor* procPtrOrNull = (WsfProcessor*)componentPtr->QueryComponentInterface(cWSF_COMPONENT_PROCESSOR);

Implements WsfComponent.

References cWSF_COMPONENT_FUEL, cWSF_COMPONENT_PLATFORM_PART, and WsfPlatformPart::WsfPlatformPart().

◆ Refuel() [1/2]

bool WsfFuel::Refuel ( double aSimTime )

virtual

Instantaneous refueling.

Completely fill up with fuel (instantaneous). This tells the derived class to set its 'current fuel' to the maximum allowed.

Parameters

aSimTime [input] The current simulation time.

Returns: Returns 'true'.

Reimplemented in wsf::six_dof::Fuel, and WsfP6DOF_Fuel.

References ExecuteRefuelScript(), mLastUpdate, ResetFlags(), and SetQuantityRemaining().

◆ Refuel() [2/2]

bool WsfFuel::Refuel	(	double	aSimTime,
		double	aQuantity )

virtual

Completely fill up with fuel (instantaneous). This tells the derived class to set its 'current fuel' to the supplied quantity.

Parameters

aSimTime	[input] The current simulation time.
aQuantity	[input] The fuel quantity supplied.

Returns: Always returns 'true'.

Reimplemented in wsf::six_dof::Fuel, and WsfP6DOF_Fuel.

References ExecuteRefuelScript(), mLastUpdate, ResetFlags(), and SetQuantityRemaining().

◆ ResetFlags()

void WsfFuel::ResetFlags ( )

protected

References mBingoQuantity, and mReserveQuantity.

Referenced by WsfTankedFuel::DisconnectFromTanker(), Initialize(), operator=(), Refuel(), Refuel(), SetBingoQuantity(), and SetReserveQuantity().

◆ SetBingoQuantity()

void WsfFuel::SetBingoQuantity ( double aQuantity )

Sets the current bingo fuel quantity.

Parameters

aQuantity [input] The bingo fuel quantity.

References CheckEvents(), WsfPlatformPart::GetSimulation(), mBingoQuantity, and ResetFlags().

◆ SetConsumptionRate()

void WsfFuel::SetConsumptionRate ( double aRate )

inline

Referenced by WsfP6DOF_Fuel::UpdateP6DofFuelData(), and wsf::six_dof::Fuel::UpdateSixDOF_FuelData().

◆ SetInitialQuantity()

virtual void WsfFuel::SetInitialQuantity ( double aQuantity )

inlinevirtual

Referenced by WsfBrawlerFuel::Initialize(), WsfExchange::Transactor::Initialize(), wsf::six_dof::Fuel::ProcessInput(), WsfBrawlerFuel::ProcessInput(), and WsfP6DOF_Fuel::ProcessInput().

◆ SetMaximumQuantity()

virtual void WsfFuel::SetMaximumQuantity ( double aQuantity )

inlinevirtual

Reimplemented in wsf::six_dof::Fuel, and WsfP6DOF_Fuel.

Referenced by WsfExchange::Transactor::Initialize(), wsf::six_dof::Fuel::Initialize2(), and WsfP6DOF_Fuel::Initialize2().

◆ SetMode() [1/2]

void WsfFuel::SetMode ( const std::string & aMode )

References SetMode().

◆ SetMode() [2/2]

void WsfFuel::SetMode ( WsfStringId aMode )

virtual

Reimplemented in WsfTabularRateFuel, and WsfVariableRateFuel.

Referenced by SetMode(), WsfTabularRateFuel::SetMode(), and WsfVariableRateFuel::SetMode().

◆ SetPlatform()

void WsfFuel::SetPlatform ( WsfPlatform * aPlatformPtr )

overridevirtual

Set the platform to which this part is associated.

Parameters

aPlatformPtr Pointer to the containing platform.

Note: A part can be associated with only one platform. It is an error to associate a part with more than one platform!

Reimplemented from WsfPlatformPart.

References WsfPlatform::GetScriptContext(), and WsfPlatformPart::SetPlatform().

◆ SetQuantityRemaining()

void WsfFuel::SetQuantityRemaining ( double aQuantity )

virtual

Sets the current fuel quantity.

Parameters

aQuantity [input] The fuel quantity.

References WsfPlatformPart::GetPlatform(), and WsfPlatform::SetFuelMass().

Referenced by DecrementQuantity(), IncrementQuantity(), WsfExchange::Transactor::Initialize(), Initialize(), Refuel(), Refuel(), WsfP6DOF_Fuel::UpdateP6DofFuelData(), and wsf::six_dof::Fuel::UpdateSixDOF_FuelData().

◆ SetReserveQuantity()

void WsfFuel::SetReserveQuantity ( double aQuantity )

virtual

Sets the current reserve fuel quantity.

Parameters

aQuantity [input] The reserve fuel quantity.

References CheckEvents(), WsfPlatformPart::GetSimulation(), mReserveQuantity, and ResetFlags().

◆ SetUpdateInterval()

void WsfFuel::SetUpdateInterval ( double aUpdateInterval )

inlineoverrideprotectedvirtual

Set the time interval between the periodic calls to Update(). A value of less than or equal to zero indicates periodic updates are not to be performed.

Parameters

aUpdateInterval The new update interval.

Note: Users should call WsfSimulation::GetInstance().SetProcessorUpdateInterval() to set the interval.

Implements WsfPlatformPart.

◆ TimeAt() [1/2]

double WsfFuel::TimeAt ( FuelState aFuelState )

Returns the time at the given fuel state based on the current consumption rate.

Gets the number of seconds of fuel represented at the fuel state for current flight conditions.

Parameters

aFuelState [input] The fuel state to check.

Returns: Time in seconds of fuel state

References WsfPlatformPart::GetPlatform(), platformPtr, and TimeAt().

Referenced by DistanceAt(), and TimeAt().

◆ TimeAt() [2/2]

double WsfFuel::TimeAt	(	FuelState	aFuelState,
		const double	aSpeed,
		const double	aAltitude )

Returns the time at the given fuel state based on the consumption of the given altitude and speed.

Gets the number of seconds of fuel represented at the fuel state for input flight parameters.

Parameters

aFuelState	[input] The fuel state to check.
aSpeed	[input] The speed to use for calculation
aAltitude	[input] The altitude to use for calculation

Returns: Time in seconds of bingo fuel

References GetConsumptionRate(), mBingoQuantity, mReserveQuantity, ON_BINGO, ON_EMPTY, and ON_RESERVE.

◆ TimeTo() [1/2]

double WsfFuel::TimeTo ( FuelState aFuelState )

Returns the time to the given fuel state based on the current consumption rate.

Gets the time to the given fuel state based on the current consumption rate.

Parameters

aFuelState [input] The fuel state to check.

Returns: Time in seconds to the given fuel state.

References WsfPlatformPart::GetPlatform(), platformPtr, and TimeTo().

Referenced by DistanceTo(), and TimeTo().

◆ TimeTo() [2/2]

double WsfFuel::TimeTo	(	FuelState	aFuelState,
		const double	aAltitude,
		const double	aSpeed )

Returns the time to the given fuel state based on the consumption of the given altitude and speed.

Gets the time to the given fuel state based on the consumption rate at the given altitude and speed.

Parameters

aFuelState	[input] The fuel state to check.
aAltitude	[input] The desired altitude
aSpeed	[input] The desired speed

Returns: Time in seconds to the given fuel state.

References GetNetDepletionRate(), mBingoQuantity, mReserveQuantity, ON_BINGO, ON_EMPTY, and ON_RESERVE.

◆ Update()

void WsfFuel::Update ( double aSimTime )

overridevirtual

Updates the fuel data.

Parameters

aSimTime [input] The current simulation time.

Reimplemented from WsfPlatformPart.

Reimplemented in WsfP6DOF_Fuel, and WsfTankedFuel.

References CalculateDeltaQuantity(), CheckEvents(), DecrementQuantity(), and mLastUpdate.

Referenced by OnPlatformUpdated(), and WsfTankedFuel::Update().

Member Data Documentation

◆ mBingoQuantity

double WsfFuel::mBingoQuantity

protected

Reserve fuel (defaults to 0).

Referenced by CheckEvents(), GetBingoQuantity(), wsf::six_dof::Fuel::ProcessInput(), ProcessInput(), WsfP6DOF_Fuel::ProcessInput(), ResetFlags(), SetBingoQuantity(), TimeAt(), TimeTo(), WsfFuel(), and WsfFuel().

◆ mLastUpdate

double WsfFuel::mLastUpdate

protected

Referenced by CalculateDeltaQuantity(), GetLastUpdateTime(), Initialize(), Refuel(), Refuel(), wsf::six_dof::Fuel::Update(), Update(), WsfP6DOF_Fuel::Update(), WsfFuel(), and WsfFuel().

◆ mReserveQuantity

double WsfFuel::mReserveQuantity

protected

Referenced by CheckEvents(), GetReserveQuantity(), wsf::six_dof::Fuel::ProcessInput(), ProcessInput(), WsfP6DOF_Fuel::ProcessInput(), ResetFlags(), SetReserveQuantity(), TimeAt(), TimeTo(), WsfFuel(), and WsfFuel().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Fuel prediction methods

Component infrastructure methods not provided by WsfPlatformPart.

Common infrastructure methods.

WsfPlatformPart methods.

Overrides of WsfSinglePlatformObserver

Fuel quantity accessor and mutators

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FuelState

Constructor & Destructor Documentation

◆ WsfFuel() [1/2]

◆ ~WsfFuel()

◆ WsfFuel() [2/2]

Member Function Documentation

◆ CalcConsumptionRate()

◆ CalcConsumptionRateAltitudeSpeed()

◆ CalculateDeltaQuantity()

◆ CheckEvents()

◆ Clone()

◆ CloneComponent()

◆ DecrementQuantity()

◆ DistanceAt() [1/2]

◆ DistanceAt() [2/2]

◆ DistanceTo() [1/2]

◆ DistanceTo() [2/2]

◆ ExecuteBingoScript()

◆ ExecuteEmptyScript()

◆ ExecuteRefuelScript()

◆ ExecuteReserveScript()

◆ FuelSeconds() [1/2]

◆ FuelSeconds() [2/2]

◆ FuelSecondsRemaining()

◆ GetBingoQuantity()

◆ GetComponentInitializationOrder()

◆ GetComponentRoles()

◆ GetConsumptionRate() [1/2]

◆ GetConsumptionRate() [2/2]

◆ GetInitialQuantity()

◆ GetLastUpdateTime()

◆ GetMaximumQuantity()

◆ GetMode()

◆ GetModeId()

◆ GetNetDepletionRate() [1/2]

◆ GetNetDepletionRate() [2/2]

◆ GetQuantityRemaining()

◆ GetQuantityRequired() [1/3]

◆ GetQuantityRequired() [2/3]

◆ GetQuantityRequired() [3/3]

◆ GetReceiveRate()

◆ GetReserveQuantity()

◆ GetScriptClassName()

◆ GetSupplyRate()

◆ GetUpdateInterval()

◆ IncrementQuantity()

◆ Initialize()

◆ Initialize2()

◆ IsBingo()

◆ IsEmpty()

◆ IsOnReserve()

◆ OnPlatformUpdated()

◆ operator=()

◆ ProcessInput()

◆ QueryInterface()

◆ Refuel() [1/2]

◆ Refuel() [2/2]

◆ ResetFlags()

◆ SetBingoQuantity()

◆ SetConsumptionRate()

◆ SetInitialQuantity()

◆ SetMaximumQuantity()

◆ SetMode() [1/2]

◆ SetMode() [2/2]

◆ SetPlatform()

◆ SetQuantityRemaining()

◆ SetReserveQuantity()

◆ SetUpdateInterval()

◆ TimeAt() [1/2]