WsfFuel.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
// ****************************************************************************
// Updated by Infoscitex, a DCS Company
// ****************************************************************************
 
#ifndef WSFFUEL_HPP
#define WSFFUEL_HPP
 
#include "wsf_export.h"
 
class UtScript;
#include "WsfPlatformPart.hpp"
class WsfRoute;
class WsfScriptContext;
#include "WsfSinglePlatformObserver.hpp"

class WSF_EXPORT WsfFuel : public WsfPlatformPart, public WsfSinglePlatformObserver
{
public:
   enum FuelState
   {
      ON_BINGO   = 0,
      ON_RESERVE = 1,
      ON_EMPTY   = 2
   };
 
   WsfFuel(WsfScenario& aScenario);
   ~WsfFuel() override;
 
   WsfFuel* Clone() const override;


   WsfComponent* CloneComponent() const override { return Clone(); }
   const int*    GetComponentRoles() const override;
   void*         QueryInterface(int aRole) override;
   int           GetComponentInitializationOrder() const override { return cWSF_INITIALIZE_ORDER_FUEL; }


   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;
   // NOTE: Fuel does not utilize TurnOn/TurnOff. It is updated when the mover is updated.
   //       If the mover is off then the fuel is considered to be off, and vice versa.


   void OnPlatformUpdated(double aSimTime, WsfPlatform* aPlatformPtr) override;


   virtual double GetConsumptionRate() { return mConsumeRate; }
   virtual double GetConsumptionRate(const double aAltitude, const double aSpeed);
   void           SetConsumptionRate(double aRate) { mConsumeRate = aRate; }
 
   virtual double GetSupplyRate() const { return 0.0; }
   virtual double GetReceiveRate() const { return 0.0; }
 
   virtual double GetNetDepletionRate();
   virtual double GetNetDepletionRate(const double aAltitude, const double aSpeed);
 
   virtual double GetMaximumQuantity() const { return mMaximumQuantity; }
   virtual void   SetMaximumQuantity(double aQuantity) { mMaximumQuantity = aQuantity; }
 
   virtual double GetInitialQuantity() const { return mInitialQuantity; }
   virtual void   SetInitialQuantity(double aQuantity) { mInitialQuantity = aQuantity; }
 
   virtual double GetReserveQuantity() const { return mReserveQuantity; }
   virtual void   SetReserveQuantity(double aQuantity);
 
   double GetBingoQuantity() const { return mBingoQuantity; }
   void   SetBingoQuantity(double aQuantity);
 
   virtual double GetQuantityRemaining() const { return mCurrentQuantity; }
   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);


 
   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);
   double TimeAt(FuelState aFuelState, const double aSpeed, const double aAltitude);

   double TimeTo(FuelState aFuelState);
   double TimeTo(FuelState aFuelState, const double aAltitude, const double aSpeed);

   double DistanceAt(FuelState aFuelState);
   double DistanceAt(FuelState aFuelState, const double aAltitude, const double aSpeed);

   double DistanceTo(FuelState aFuelState);
   double DistanceTo(FuelState aFuelState, const double aAltitude, const double aSpeed);

 
   bool IsBingo() const { return mBingoEventTriggered; }
   bool IsOnReserve() const { return mReserveEventTriggered; }
   bool IsEmpty() const { return mEmptyEventTriggered; }

   virtual bool Refuel(double aSimTime);
   virtual bool Refuel(double aSimTime, double aQuantity);
 
   virtual WsfStringId GetModeId() const { return mMode; }
   virtual std::string GetMode() const;
 
   virtual void SetMode(WsfStringId aMode);
   void         SetMode(const std::string& aMode);
 
   void SetPlatform(WsfPlatform* aPlatformPtr) override;
 
protected:
   // WsfFuel by default has no update interval
   // Override these methods to get regular Update() calls
   void   SetUpdateInterval(double aInterval) override {}
   double GetUpdateInterval() const override { return 0.0; }
 
   double GetLastUpdateTime() const { return mLastUpdate; }
 
   virtual double CalcConsumptionRate();
 
   // Derived classes should use lookup tables for the consumption rate at different altitudes and speeds
   virtual double CalcConsumptionRateAltitudeSpeed(const double aAltitude, const double aSpeed);
 
   // Make internal scripts available to derived classes:
   void ExecuteEmptyScript(double aSimTime);
   void ExecuteReserveScript(double aSimTime);
   void ExecuteBingoScript(double aSimTime);
   void ExecuteRefuelScript(double aSimTime);

   WsfFuel(const WsfFuel& aSrc);

   WsfFuel& operator=(const WsfFuel& aSrc) = delete;

   virtual double CalculateDeltaQuantity(double aSimTime);
 
   void IncrementQuantity(double aDelta);
   void DecrementQuantity(double aDelta);

   void CheckEvents(double aSimTime);
 
   void ResetFlags();
 
   double mLastUpdate;
   double mReserveQuantity; 
   double mBingoQuantity;   
 
private:
   WsfScriptContext* mContextPtr;
   UtScript*         mOnEmptyScriptPtr;
   UtScript*         mOnReserveScriptPtr;
   UtScript*         mOnBingoScriptPtr;
   UtScript*         mOnRefuelScriptPtr;
 
   double mConsumeRate; // Positive = Decreasing Quantity, Negative = Increasing Quantity
 
   double mMaximumQuantity; 
   double mInitialQuantity; 
   double mCurrentQuantity; 
 
   bool mBingoEventTriggered;
   bool mReserveEventTriggered;
   bool mEmptyEventTriggered;
   bool mFirstDeltaUpdate;
 
   WsfStringId mMode; // Implementation-defined named mode that <may> impact fuel consumption.
};
 
WSF_DECLARE_COMPONENT_ROLE_TYPE(WsfFuel, cWSF_COMPONENT_FUEL)
 
#endif