WsfTabularRateFuel Class Reference

#include <WsfTabularRateFuel.hpp>

Inheritance diagram for WsfTabularRateFuel:

Collaboration diagram for WsfTabularRateFuel:

Classes
struct	Array
struct	InputData

Public Types
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...
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.

Public Member Functions
	WsfTabularRateFuel (WsfScenario &aScenario)
WsfTabularRateFuel &	operator= (const WsfTabularRateFuel &)=delete
	~WsfTabularRateFuel () override
WsfFuel *	Clone () const override
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	Update (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	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)
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)
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.

Common infrastructure methods.
using	RateTableMap = std::map<WsfStringId, WsfFuelFlow*>
bool	Initialize (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	SetMode (WsfStringId aMode) override

External Services access.
These methods support the External Services and are not part of the WSF public interface.
using	RateTablePair = std::pair<WsfStringId, WsfFuelFlow*>
using	RateTableConstIter = RateTableMap::const_iterator
using	RateTableIter = RateTableMap::iterator
virtual const RateTableMap &	GetRateTableMap ()
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 ()

Additional Inherited Members
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
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)
double	mLastUpdate
double	mReserveQuantity
double	mBingoQuantity
	Reserve fuel (defaults to 0).

Detailed Description

Fuel consumption rate model.

This class defines fuel consumption behavior, at either constant rates, or at variable rates based upon one to three independent variable (the choices are platform altitude, weight, and speed). By default, if fuel Mode is ignored, only one table is accepted, however, multiple tables may be defined for different Modes if desired. The active table is switched by setting the fuel Mode, unless there is no table for that Mode, in which case the active table will not be changed. (This model differs from the similar WsfVariableRateFuel in that the tables must be rectangular, and this class allows for 3-D tables versus only 2-D for WsfVariableRateFuel.)

Member Typedef Documentation

RateTableConstIter

using WsfTabularRateFuel::RateTableConstIter = RateTableMap::const_iterator

protected

RateTableIter

using WsfTabularRateFuel::RateTableIter = RateTableMap::iterator

protected

RateTableMap

using WsfTabularRateFuel::RateTableMap = std::map<WsfStringId, WsfFuelFlow*>

RateTablePair

using WsfTabularRateFuel::RateTablePair = std::pair<WsfStringId, WsfFuelFlow*>

protected

Member Enumeration Documentation

TableType

enum WsfTabularRateFuel::TableType

Enumeration to select the fuel consumption rate table lookup type.

Enumerator
cCONSTANT	Constant (No table lookup required).
cONE_D	A function of one independent variable.
cTWO_D	A function of two independent variables.
cTHREE_D	A function of three independent variables.

VarType

enum WsfTabularRateFuel::VarType

Enumeration to identify the variable for a fuel flow table.

Enumerator
cNO_VARTYPE	Not yet set.
cSPEED	Function of speed.
cALTITUDE	Function of altitude.
cMASS	Function of mass.
cRATES	Fuel Flow Rate (dependent variable).

Constructor & Destructor Documentation

WsfTabularRateFuel() [1/2]

WsfTabularRateFuel::WsfTabularRateFuel

(

WsfScenario &

aScenario

)

References WsfFuel::WsfFuel().

Referenced by Clone(), operator=(), WsfTabularRateFuel(), WsfTankedFuel::WsfTankedFuel(), and WsfTankedFuel::WsfTankedFuel().

~WsfTabularRateFuel()

WsfTabularRateFuel::~WsfTabularRateFuel ( )

override

WsfTabularRateFuel() [2/2]

WsfTabularRateFuel::WsfTabularRateFuel ( const WsfTabularRateFuel & aSrc )

protected

Copy constructor (for Clone()).

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

Member Function Documentation

CalcConsumptionRate()

double WsfTabularRateFuel::CalcConsumptionRate ( )

overrideprotectedvirtual

Calculates the consumption rate.

Calculates the fuel consumption rate.

Returns

A fuel consumption rate.

Reimplemented from WsfFuel.

References WsfFuelFlow::CalcConsumptionRate(), GetCurrentTable(), WsfFuel::GetMode(), WsfObject::GetName(), and WsfPlatformPart::GetPlatform().

CalcConsumptionRateAltitudeSpeed()

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

overrideprotectedvirtual

Calculates the fuel consumption rate.

Returns

A fuel consumption rate.

Reimplemented from WsfFuel.

References WsfFuelFlow::CalcConsumptionRateAltitudeSpeed(), GetCurrentTable(), WsfFuel::GetMode(), WsfObject::GetName(), and WsfPlatformPart::GetPlatform().

Clone()

WsfFuel * WsfTabularRateFuel::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 WsfFuel.

Reimplemented in WsfTankedFuel.

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

GetCurrentTable()

WsfFuelFlow * WsfTabularRateFuel::GetCurrentTable ( )

protected

References WsfFuel::GetModeId().

Referenced by CalcConsumptionRate(), CalcConsumptionRateAltitudeSpeed(), and Initialize().

GetRateTableMap()

virtual const RateTableMap & WsfTabularRateFuel::GetRateTableMap ( )

inlinevirtual

Initialize()

bool WsfTabularRateFuel::Initialize ( double aSimTime )

overridevirtual

Initialize the fuel object.

Returns

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

Reimplemented from WsfFuel.

Reimplemented in WsfTankedFuel.

References GetCurrentTable(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfFuel::Initialize(), and success.

Referenced by WsfTankedFuel::Initialize().

operator=()

WsfTabularRateFuel & WsfTabularRateFuel::operator= ( const WsfTabularRateFuel & )

delete

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

ProcessInput()

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

Reimplemented in WsfTankedFuel.

References WsfFuel::ProcessInput(), and ProcessTableBlock().

Referenced by WsfTankedFuel::ProcessInput().

ProcessMachBlock()

void WsfTabularRateFuel::ProcessMachBlock ( UtInputBlock & aInputBlock, Array & aArray )

protected

References WsfTabularRateFuel::Array::Values.

Referenced by ProcessTableBlock().

ProcessTableBlock()

void WsfTabularRateFuel::ProcessTableBlock ( UtInputBlock & aInputBlock )

protected

References cALTITUDE, cCONSTANT, WsfTabularRateFuel::Array::Check(), cMASS, cRATES, cSPEED, WsfTabularRateFuel::InputData::Data, WsfTabularRateFuel::InputData::FirstIV, WsfTabularRateFuel::InputData::Mode, ProcessMachBlock(), ProcessVarBlock(), WsfTabularRateFuel::InputData::SecondIV, WsfFuelFlow::SetTableSpeedIsInMach(), WsfTabularRateFuel::InputData::Table, WsfTabularRateFuel::InputData::ThirdIV, WsfTabularRateFuel::Array::Values, and WsfTabularRateFuel::Array::Variable.

Referenced by ProcessInput().

ProcessVarBlock()

void WsfTabularRateFuel::ProcessVarBlock ( UtInputBlock & aInputBlock, UtInput::ValueType aType, Array & aArray )

protected

References WsfTabularRateFuel::Array::ConvFactor, and WsfTabularRateFuel::Array::Values.

Referenced by ProcessTableBlock().

SetMode()

void WsfTabularRateFuel::SetMode ( WsfStringId aMode )

overridevirtual

Reimplemented from WsfFuel.

References WsfFuel::SetMode().

---

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

• WsfTabularRateFuel.hpp
• WsfTabularRateFuel.cpp