#include <WsfSixDOF_Fuel.hpp>

Inheritance diagram for wsf::six_dof::Fuel:

[legend]

Collaboration diagram for wsf::six_dof::Fuel:

[legend]

Public Member Functions
	Fuel (WsfScenario &aScenario)
	~Fuel ()=default
Fuel &	operator= (const Fuel &other)=delete
WsfFuel *	Clone () const override
Public Member Functions inherited from WsfFuel
	WsfFuel (WsfScenario &aScenario)
	~WsfFuel () override
WsfFuel *	Clone () const 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 WsfStringId	GetModeId () const
virtual std::string	GetMode () const
virtual void	SetMode (WsfStringId aMode)
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	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	Update (double aSimTime) override
void	OnPlatformUpdated (double aSimTime, WsfPlatform *aPlatformPtr) override
	Callback from platform when the mover is updated.
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 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 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	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.

WsfPlatformPart methods.
Mover *	mMoverPtr = nullptr
bool	Initialize2 (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	Update (double aSimTime) override
void	SetMover (Mover *aMover)
double	GetConsumptionRate () override
double	GetConsumptionRate (const double aAltitude, const double aSpeed) override
void	SetMaximumQuantity (double aQuantity) override
double	GetQuantityRemaining () const override
bool	Refuel (double aSimTime) override
	Instantaneous refueling.
bool	Refuel (double aSimTime, double aQuantity) override
	Fuel (const Fuel &aSrc)
void	SetSixDOF_Mover ()
void	UpdateSixDOF_FuelData (double aSimTime)
double	CalcConsumptionRate () override
double	CalcConsumptionRateAltitudeSpeed (const double aAltitude, const double aSpeed) override

Additional Inherited Members
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
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

This class derives from WsfFuel and provides a class that provides a simple base class for fuel objects. Functions include fuel consumption rate and current fuel quantity, as well as "Bingo" fuel state and calculations for how far the vehicle can fly with various conditions. WsfSixDOF_Fuel supports as many WsfFuel functions as possible – in some cases the more advanced

Constructor & Destructor Documentation

◆ Fuel() [1/2]

wsf::six_dof::Fuel::Fuel ( WsfScenario & aScenario )

explicit

References WsfFuel::WsfFuel().

Referenced by Clone(), Fuel(), and operator=().

◆ ~Fuel()

wsf::six_dof::Fuel::~Fuel ( )

default

◆ Fuel() [2/2]

wsf::six_dof::Fuel::Fuel ( const Fuel & aSrc )

protected

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

Member Function Documentation

◆ CalcConsumptionRate()

double wsf::six_dof::Fuel::CalcConsumptionRate ( )

overrideprotectedvirtual

Reimplemented from WsfFuel.

References mMoverPtr.

Referenced by CalcConsumptionRateAltitudeSpeed().

◆ CalcConsumptionRateAltitudeSpeed()

double wsf::six_dof::Fuel::CalcConsumptionRateAltitudeSpeed	(	const double	aAltitude,
		const double	aSpeed )

overrideprotectedvirtual

Reimplemented from WsfFuel.

References CalcConsumptionRate().

◆ Clone()

WsfFuel * wsf::six_dof::Fuel::Clone ( ) const

overridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

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

Referenced by operator=().

◆ GetConsumptionRate() [1/2]

double wsf::six_dof::Fuel::GetConsumptionRate ( )

overridevirtual

Reimplemented from WsfFuel.

References mMoverPtr.

Referenced by GetConsumptionRate().

◆ GetConsumptionRate() [2/2]

double wsf::six_dof::Fuel::GetConsumptionRate	(	const double	aAltitude,
		const double	aSpeed )

overridevirtual

Reimplemented from WsfFuel.

References GetConsumptionRate().

◆ GetQuantityRemaining()

double wsf::six_dof::Fuel::GetQuantityRemaining ( ) const

overridevirtual

Reimplemented from WsfFuel.

References mMoverPtr.

◆ Initialize2()

bool wsf::six_dof::Fuel::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.

References WsfFuel::GetInitialQuantity(), WsfFuel::Initialize2(), mMoverPtr, WsfFuel::SetMaximumQuantity(), and SetSixDOF_Mover().

Referenced by operator=().

◆ operator=()

Fuel & wsf::six_dof::Fuel::operator= ( const Fuel & other )

delete

References Clone(), Fuel(), Initialize2(), ProcessInput(), and WsfFuel::WsfFuel().

◆ ProcessInput()

bool wsf::six_dof::Fuel::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfObject.

References WsfFuel::mBingoQuantity, WsfFuel::mReserveQuantity, WsfFuel::ProcessInput(), and WsfFuel::SetInitialQuantity().

Referenced by operator=().

◆ Refuel() [1/2]

bool wsf::six_dof::Fuel::Refuel ( double aSimTime )

overridevirtual

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 from WsfFuel.

References mMoverPtr.

◆ Refuel() [2/2]

bool wsf::six_dof::Fuel::Refuel	(	double	aSimTime,
		double	aQuantity )

overridevirtual

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 from WsfFuel.

References mMoverPtr.

◆ SetMaximumQuantity()

void wsf::six_dof::Fuel::SetMaximumQuantity ( double aQuantity )

overridevirtual

Reimplemented from WsfFuel.

◆ SetMover()

void wsf::six_dof::Fuel::SetMover ( Mover * aMover )

inline

References mMoverPtr.

◆ SetSixDOF_Mover()

void wsf::six_dof::Fuel::SetSixDOF_Mover ( )

protected

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

Referenced by Initialize2().

◆ Update()

void wsf::six_dof::Fuel::Update ( double aSimTime )

overridevirtual

Update the state of an platform part. Updates the platform part to reflect the state at the specified simulation time.

Parameters

aSimTime The current simulation time.

Reimplemented from WsfPlatformPart.

References WsfFuel::CheckEvents(), WsfFuel::GetLastUpdateTime(), WsfFuel::mLastUpdate, mMoverPtr, and UpdateSixDOF_FuelData().

◆ UpdateSixDOF_FuelData()

void wsf::six_dof::Fuel::UpdateSixDOF_FuelData ( double aSimTime )

protected

References mMoverPtr, WsfFuel::SetConsumptionRate(), and WsfFuel::SetQuantityRemaining().

Referenced by Update().

Member Data Documentation

◆ mMoverPtr

Mover* wsf::six_dof::Fuel::mMoverPtr = nullptr

protected

Referenced by CalcConsumptionRate(), GetConsumptionRate(), GetQuantityRemaining(), Initialize2(), Refuel(), Refuel(), SetMover(), SetSixDOF_Mover(), Update(), and UpdateSixDOF_FuelData().

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

Public Member Functions

WsfPlatformPart methods.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Fuel() [1/2]

◆ ~Fuel()

◆ Fuel() [2/2]

Member Function Documentation

◆ CalcConsumptionRate()

◆ CalcConsumptionRateAltitudeSpeed()

◆ Clone()

◆ GetConsumptionRate() [1/2]

◆ GetConsumptionRate() [2/2]

◆ GetQuantityRemaining()

◆ Initialize2()

◆ operator=()

◆ ProcessInput()

◆ Refuel() [1/2]

◆ Refuel() [2/2]

◆ SetMaximumQuantity()

◆ SetMover()

◆ SetSixDOF_Mover()

◆ Update()

◆ UpdateSixDOF_FuelData()

Member Data Documentation

◆ mMoverPtr