#include <WsfTankedFuel.hpp>

Inheritance diagram for WsfTankedFuel:

[legend]

Collaboration diagram for WsfTankedFuel:

[legend]

Public Member Functions
	WsfTankedFuel (WsfScenario &aScenario)
WsfTankedFuel &	operator= (const WsfTankedFuel &)=delete
	~WsfTankedFuel () override
WsfFuel *	Clone () const override
bool	Initialize (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	Update (double aSimTime) override
void	PlatformDeleted (WsfPlatform *aPlatformPtr) override
bool	SupplyInProcess () const
bool	ReceiveInProcess () const
double	MaxReceiveRate () const
	Maximum mass flow rate for this tank while receiving fuel.
bool	TerminateAll (double aSimTime)
bool	DisconnectFuelingOps (double aSimTime)
	Method requesting to terminate all supplying operations to other tanks.
bool	DisconnectFromTanker (double aSimTime)
	Method requesting to disconnect the tank supplying fuel into this tank.
bool	DisconnectFrom (double aSimTime, WsfPlatform *aPlatformPtr)
double	CurrentSupplyRate () const
	Returns the current rate at which this tank is supplying fuel to another.
double	CurrentReceiveRate () const
	Returns the current rate at which this tank is receiving fuel from another.
double	GetOpBandMaximum () const
bool	IsSupplyCapable () const
	Returns an indication that this tank is enabled to supply fuel to another.
bool	IsReceiveCapable () const
	Returns an indication that this tank is enabled to receive fuel from another.
bool	IsReceiveReady () const
WsfFuelingOperation::MethodType	ReceiveMethod () const
	Returns an enumeration indicating how this tank may receive fuel.
bool	FindStationFor (WsfTankedFuel *aReceiverPtr, WsfFuelingOperation::SupplyPointIter &aStationIter)
bool	BeginSupplyingFuelTo (double aSimTime, WsfTankedFuel *aReceiverPtr)
double	GetSupplyRate () const override
	Returns the sum of all 'supply' fueling operations in progress.
double	GetReceiveRate () const override
	Returns the rate of a 'receive' fueling operation in progress (if any).
bool	ConnectTanker (double aSimTime, size_t aTankerIndex, WsfTankedFuel *aSourcePtr, double aTransferRate)
virtual double	IncrementQuantity (double aSimTime, double aDelta)
virtual double	DecrementQuantity (double aSimTime, double aDelta)
void	SetSupplyMethodPreference (WsfFuelingOperation::MethodType aSupplyMethod)
void	SetSupplyLocationPreference (WsfFuelingOperation::Preference aLocationPref)
Public Member Functions inherited from WsfTabularRateFuel
	WsfTabularRateFuel (WsfScenario &aScenario)
WsfTabularRateFuel &	operator= (const WsfTabularRateFuel &)=delete
	~WsfTabularRateFuel () override
void	SetMode (WsfStringId aMode) override
virtual const RateTableMap &	GetRateTableMap ()
Public Member Functions inherited from WsfFuel
	WsfFuel (WsfScenario &aScenario)
	~WsfFuel () override
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
void	SetMode (const std::string &aMode)
void	SetPlatform (WsfPlatform *aPlatformPtr) override
WsfComponent *	CloneComponent () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
int	GetComponentInitializationOrder () const override
const char *	GetScriptClassName () const override
bool	Initialize2 (double aSimTime) override
void	OnPlatformUpdated (double aSimTime, WsfPlatform *aPlatformPtr) override
	Callback from platform when the mover is updated.
virtual double	GetConsumptionRate ()
virtual double	GetConsumptionRate (const double aAltitude, const double aSpeed)
void	SetConsumptionRate (double aRate)
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)
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	Initialize2 (double aSimTime) override
WsfPlatform *	GetPlatform () const
virtual void	PlatformAdded (double aSimTime, 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.

Static Public Member Functions
static WsfStringId	TypeId ()
	String ID of this type of software object.

Protected Member Functions
	WsfTankedFuel (const WsfTankedFuel &aSrc)
	Copy constructor (for Clone()).
bool	SetDefaultSupplyConfig ()
virtual double	UpdateFuelingOps (double aSimTime)
void	ProcessTableBlock (UtInputBlock &aInputBlock)
void	ProcessVarBlock (UtInputBlock &aInputBlock, UtInput::ValueType aType, Array &aArray)
void	ProcessMachBlock (UtInputBlock &aInputBlock, Array &aArray)
	WsfTabularRateFuel (const WsfTabularRateFuel &aSrc)
	Copy constructor (for Clone()).
double	CalcConsumptionRate () override
	Calculates the consumption rate.
double	CalcConsumptionRateAltitudeSpeed (const double aAltitude, const double aSpeed) override
WsfFuelFlow *	GetCurrentTable ()
void	SetUpdateInterval (double aInterval) override
double	GetUpdateInterval () const override
double	GetLastUpdateTime () const
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 ()
	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)

Additional Inherited Members
Public Types inherited from WsfTabularRateFuel
enum	VarType { cNO_VARTYPE = 0 , cSPEED , cALTITUDE , cMASS , cRATES }
	Enumeration to identify the variable for a fuel flow table. More...
enum	TableType { cCONSTANT , cONE_D , cTWO_D , cTHREE_D }
	Enumeration to select the fuel consumption rate table lookup type. More...
using	RateTableMap = std::map<WsfStringId, WsfFuelFlow*>
Public Types inherited from WsfFuel
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.
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
using	RateTablePair = std::pair<WsfStringId, WsfFuelFlow*>
using	RateTableConstIter = RateTableMap::const_iterator
using	RateTableIter = RateTableMap::iterator
double	mLastUpdate
double	mReserveQuantity
double	mBingoQuantity
	Reserve fuel (defaults to 0).

Detailed Description

A class which models a tanked quantity of fuel.

This class models a tank of liquid fuel, which may be consumed from and externally refueled. As a resource for a Tanker, it may feed fuel to more than one client (Receiver) simultaneous- ly, but may receive from only one supplier (Tanker) at a time. Preferred quantity levels may be specified that indicate a desired refueling 'hysteresis band' of fuel to maintain during ferry missions, when constantly in proximity to a Tanker. Scripted responses may be defined that react when a fuel level rises above or falls below this band.

Constructor & Destructor Documentation

◆ WsfTankedFuel() [1/2]

WsfTankedFuel::WsfTankedFuel ( WsfScenario & aScenario )

References WsfTabularRateFuel::WsfTabularRateFuel().

Referenced by BeginSupplyingFuelTo(), Clone(), ConnectTanker(), FindStationFor(), operator=(), and WsfTankedFuel().

◆ ~WsfTankedFuel()

WsfTankedFuel::~WsfTankedFuel ( )

override

◆ WsfTankedFuel() [2/2]

WsfTankedFuel::WsfTankedFuel ( const WsfTankedFuel & aSrc )

protected

Copy constructor (for Clone()).

References WsfTabularRateFuel::WsfTabularRateFuel(), and WsfTankedFuel().

Member Function Documentation

◆ BeginSupplyingFuelTo()

bool WsfTankedFuel::BeginSupplyingFuelTo	(	double	aSimTime,
		WsfTankedFuel *	aReceiverPtr )

Called by a fuel "Receiver" (client) processor, while attempting to link up with a "Tanker" (supplier) for a refueling operation.

Parameters

aSimTime	Current simulated time.
aReceiverPtr	Tank that will receive the offloaded fuel.

Returns: True indicates success.

References WsfFuelingOperation::cBOOM, WsfFuelingOperation::cLEFT_WING, WsfFuelingOperation::cRIGHT_WING, WsfPlatformPart::DebugEnabled(), DecrementQuantity(), FindStationFor(), WsfObject::GetName(), GetOpBandMaximum(), WsfPlatformPart::GetPlatform(), WsfFuel::GetQuantityRemaining(), WsfFuel::GetReserveQuantity(), IncrementQuantity(), WsfFuel::IsBingo(), IsReceiveCapable(), ReceiveInProcess(), and WsfTankedFuel().

◆ Clone()

WsfFuel * WsfTankedFuel::Clone ( ) const

overridevirtual

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

Returns: A pointer to the cloned object.

Reimplemented from WsfTabularRateFuel.

References WsfFuel::WsfFuel(), and WsfTankedFuel().

◆ ConnectTanker()

bool WsfTankedFuel::ConnectTanker	(	double	aSimTime,
		size_t	aTankerIndex,
		WsfTankedFuel *	aSourcePtr,
		double	aTransferRate )

This public method is intended to be called only from WsfFuelingOperation:

Parameters

aSimTime	Current simulated time.
aTankerIndex	Platform Index of the Tanker which will fuel the tank.
aSourcePtr	Pointer to the supplying tank of fuel.
aTransferRate	The rate of transfer fo fuel from the tanker to the receiver.

Returns: Returns true if the connection was successful.

References Update(), and WsfTankedFuel().

◆ CurrentReceiveRate()

double WsfTankedFuel::CurrentReceiveRate ( ) const

inline

Returns the current rate at which this tank is receiving fuel from another.

◆ CurrentSupplyRate()

double WsfTankedFuel::CurrentSupplyRate ( ) const

inline

Returns the current rate at which this tank is supplying fuel to another.

◆ DecrementQuantity()

double WsfTankedFuel::DecrementQuantity	(	double	aSimTime,
		double	aDelta )

virtual

Decrement the quantity of fuel in the tank.

Parameters

aSimTime	Current simulated time.
aDelta	Specifies a desired amount of fuel to be supplied by the tank.

Returns: Returns the ACTUAL amount of fuel supplied (tank may be empty).

References WsfFuel::CheckEvents(), WsfPlatformPart::DebugEnabled(), WsfFuel::DecrementQuantity(), WsfObserver::FuelEvent(), WsfFuel::GetBingoQuantity(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfFuel::GetQuantityRemaining(), WsfFuel::GetReserveQuantity(), WsfPlatformPart::GetSimulation(), WsfFuel::IsBingo(), and WsfFuel::IsOnReserve().

Referenced by BeginSupplyingFuelTo().

◆ DisconnectFrom()

bool WsfTankedFuel::DisconnectFrom	(	double	aSimTime,
		WsfPlatform *	aPlatformPtr )

Method requesting to disconnect all fueling operations to/from the specified platform.

References WsfFuelingOperation::cBOOM, WsfFuelingOperation::cLEFT_WING, WsfFuelingOperation::cRIGHT_WING, WsfPlatformPart::DebugEnabled(), DisconnectFromTanker(), WsfPlatform::GetIndex(), WsfObject::GetName(), and WsfPlatformPart::GetPlatform().

◆ DisconnectFromTanker()

bool WsfTankedFuel::DisconnectFromTanker ( double aSimTime )

Method requesting to disconnect the tank supplying fuel into this tank.

References WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetSimulation(), WsfFuel::ResetFlags(), and Update().

Referenced by DisconnectFrom(), and TerminateAll().

◆ DisconnectFuelingOps()

bool WsfTankedFuel::DisconnectFuelingOps ( double aSimTime )

Method requesting to terminate all supplying operations to other tanks.

Referenced by TerminateAll().

◆ FindStationFor()

bool WsfTankedFuel::FindStationFor	(	WsfTankedFuel *	aReceiverPtr,
		WsfFuelingOperation::SupplyPointIter &	aStationIter )

Returns an indication that a fuel supply point on this aircraft is available to provide fuel to the specified Receiver tank.

Parameters

aReceiverPtr	The tank needing fuel.
aStationIter	If successful, an iterator to the station available for the receiver.

Returns: True if search was successful. (If false, aStationIter is not valid.)

References WsfFuelingOperation::AllowSimultBoomAndHoseFueling(), WsfFuelingOperation::AllowSimultWingAndCenterlineFueling(), WsfFuelingOperation::cBOOM, WsfFuelingOperation::cCENTERLINE, WsfFuelingOperation::cCHOOSE_CENTER, WsfFuelingOperation::cCHOOSE_WING, WsfFuelingOperation::cHOSE, WsfFuelingOperation::cLEFT_WING, WsfFuelingOperation::cRIGHT_WING, ReceiveMethod(), and WsfTankedFuel().

Referenced by BeginSupplyingFuelTo().

◆ GetOpBandMaximum()

double WsfTankedFuel::GetOpBandMaximum ( ) const

inline

Returns the desired operating band maximum fuel. (Aerial refueling cannot completely fill the tank, so it is less than maximum.)

Referenced by BeginSupplyingFuelTo().

◆ GetReceiveRate()

double WsfTankedFuel::GetReceiveRate ( ) const

inlineoverridevirtual

Returns the rate of a 'receive' fueling operation in progress (if any).

Reimplemented from WsfFuel.

◆ GetSupplyRate()

double WsfTankedFuel::GetSupplyRate ( ) const

inlineoverridevirtual

Returns the sum of all 'supply' fueling operations in progress.

Reimplemented from WsfFuel.

◆ IncrementQuantity()

double WsfTankedFuel::IncrementQuantity	(	double	aSimTime,
		double	aDelta )

virtual

Increment the quantity of fuel in the tank.

Parameters

aSimTime	Current simulated time.
aDelta	Specifies a desired amount of fuel to push into the tank,

Returns: Returns the ACTUAL amount of fuel accepted (tank may be full).

References WsfPlatformPart::DebugEnabled(), WsfObserver::FuelEvent(), WsfFuel::GetMaximumQuantity(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfFuel::GetQuantityRemaining(), WsfPlatformPart::GetSimulation(), and WsfFuel::IncrementQuantity().

Referenced by BeginSupplyingFuelTo().

◆ Initialize()

bool WsfTankedFuel::Initialize ( double aSimTime )

overridevirtual

Initialize the fuel object.

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

Reimplemented from WsfTabularRateFuel.

References WsfFuelingOperation::cNO_METHOD, WsfFuel::GetMaximumQuantity(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfFuel::GetQuantityRemaining(), WsfTabularRateFuel::Initialize(), ok, and SetDefaultSupplyConfig().

◆ IsReceiveCapable()

bool WsfTankedFuel::IsReceiveCapable ( ) const

inline

Returns an indication that this tank is enabled to receive fuel from another.

References WsfFuelingOperation::cNO_METHOD.

Referenced by BeginSupplyingFuelTo(), and IsReceiveReady().

◆ IsReceiveReady()

bool WsfTankedFuel::IsReceiveReady ( ) const

inline

Returns an indication that this tank is enabled to receive fuel, and is not currently receiving fuel from another.

References IsReceiveCapable(), and ReceiveInProcess().

◆ IsSupplyCapable()

bool WsfTankedFuel::IsSupplyCapable ( ) const

inline

Returns an indication that this tank is enabled to supply fuel to another.

◆ MaxReceiveRate()

double WsfTankedFuel::MaxReceiveRate ( ) const

inline

Maximum mass flow rate for this tank while receiving fuel.

◆ operator=()

WsfTankedFuel & WsfTankedFuel::operator= ( const WsfTankedFuel & )

delete

References SupplyInProcess(), WsfFuel::WsfFuel(), and WsfTankedFuel().

◆ PlatformDeleted()

void WsfTankedFuel::PlatformDeleted ( WsfPlatform * aPlatformPtr )

overridevirtual

Some other platform has been deleted from the simulation.

This is invoked (via WsfPlatform::PlatformDeleted) whenever another platform has been deleted from the simulation.

Parameters

aPlatformPtr Pointer to the platform being deleted.

Reimplemented from WsfPlatformPart.

References WsfSimulation::GetSimTime(), WsfPlatformPart::GetSimulation(), and simTime.

◆ ProcessInput()

bool WsfTankedFuel::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 WsfTabularRateFuel.

References WsfFuelingOperation::cBOOM, WsfFuelingOperation::cCENTERLINE, WsfFuelingOperation::cCHOOSE_CENTER, WsfFuelingOperation::cCHOOSE_WING, WsfFuelingOperation::cHOSE, WsfFuelingOperation::cLEFT_WING, WsfFuelingOperation::cRIGHT_WING, WsfFuel::GetBingoQuantity(), WsfFuel::GetMaximumQuantity(), and WsfTabularRateFuel::ProcessInput().

◆ ReceiveInProcess()

bool WsfTankedFuel::ReceiveInProcess ( ) const

inline

Boolean accessor indicating that this tank is currently receiving fuel from a supplier tank.

Referenced by BeginSupplyingFuelTo(), and IsReceiveReady().

◆ ReceiveMethod()

WsfFuelingOperation::MethodType WsfTankedFuel::ReceiveMethod ( ) const

inline

Returns an enumeration indicating how this tank may receive fuel.

Referenced by FindStationFor().

◆ SetDefaultSupplyConfig()

bool WsfTankedFuel::SetDefaultSupplyConfig ( )

protected

References WsfFuelingOperation::cBOOM, WsfFuelingOperation::cCENTERLINE, WsfFuelingOperation::cCHOOSE_CENTER, WsfFuelingOperation::cCHOOSE_WING, WsfFuelingOperation::cHOSE, WsfFuelingOperation::cLEFT_WING, WsfFuelingOperation::cNO_METHOD, WsfFuelingOperation::cNO_PREFERENCE, WsfFuelingOperation::cRIGHT_WING, WsfObject::GetName(), and WsfPlatformPart::GetPlatform().

Referenced by Initialize().

◆ SetSupplyLocationPreference()

void WsfTankedFuel::SetSupplyLocationPreference ( WsfFuelingOperation::Preference aLocationPref )

inline

Set the preferred location to be used in initiating the next fuel supply operation to a Receiver.

Parameters

aLocationPref The preferred locaion.

◆ SetSupplyMethodPreference()

void WsfTankedFuel::SetSupplyMethodPreference ( WsfFuelingOperation::MethodType aSupplyMethod )

inline

Set the preferred method to be used when initiating the next fuel supply operation to a Receiver.

Parameters

aSupplyMethod The desired fueling method.

◆ SupplyInProcess()

bool WsfTankedFuel::SupplyInProcess ( ) const

Boolean accessor indicating that this tank is currently supplying fuel to one (or more) Receiver fuel tanks.

Referenced by operator=().

◆ TerminateAll()

bool WsfTankedFuel::TerminateAll ( double aSimTime )

Method requesting to disconnect the fuel supplier to this tank (if any), and simultaneously terminate all operations supplying fuel to other tanks.

References DisconnectFromTanker(), and DisconnectFuelingOps().

◆ TypeId()

WsfStringId WsfTankedFuel::TypeId ( )

static

String ID of this type of software object.

◆ Update()

void WsfTankedFuel::Update ( double aSimTime )

overridevirtual

Updates the fuel data.

Parameters

aSimTime [input] The current simulation time.

Reimplemented from WsfFuel.

References WsfFuel::GetLastUpdateTime(), WsfFuel::Update(), and UpdateFuelingOps().

Referenced by ConnectTanker(), and DisconnectFromTanker().

◆ UpdateFuelingOps()

double WsfTankedFuel::UpdateFuelingOps ( double aSimTime )

protectedvirtual

References WsfFuel::IsBingo(), WsfFuel::IsEmpty(), and WsfFuel::IsOnReserve().

Referenced by Update().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfTankedFuel() [1/2]

◆ ~WsfTankedFuel()

◆ WsfTankedFuel() [2/2]

Member Function Documentation

◆ BeginSupplyingFuelTo()

◆ Clone()

◆ ConnectTanker()

◆ CurrentReceiveRate()

◆ CurrentSupplyRate()

◆ DecrementQuantity()

◆ DisconnectFrom()

◆ DisconnectFromTanker()

◆ DisconnectFuelingOps()

◆ FindStationFor()

◆ GetOpBandMaximum()

◆ GetReceiveRate()

◆ GetSupplyRate()

◆ IncrementQuantity()

◆ Initialize()

◆ IsReceiveCapable()

◆ IsReceiveReady()

◆ IsSupplyCapable()

◆ MaxReceiveRate()

◆ operator=()

◆ PlatformDeleted()

◆ ProcessInput()

◆ ReceiveInProcess()

◆ ReceiveMethod()

◆ SetDefaultSupplyConfig()

◆ SetSupplyLocationPreference()

◆ SetSupplyMethodPreference()

◆ SupplyInProcess()

◆ TerminateAll()

◆ TypeId()

◆ Update()

◆ UpdateFuelingOps()