WsfTankedFuel.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 WSFTANKEDFUEL_HPP
#define WSFTANKEDFUEL_HPP
 
#include "wsf_export.h"
 
#include "WsfFuelingOperation.hpp"
#include "WsfTabularRateFuel.hpp"

class WSF_EXPORT WsfTankedFuel : public WsfTabularRateFuel
{
public:
   static WsfStringId TypeId();
 
   // Constructors/Destructor
   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 { return mReceiveInProcess; }

   double MaxReceiveRate() const { return mMaxReceiveRate; }

   bool TerminateAll(double aSimTime);

   bool DisconnectFuelingOps(double aSimTime);

   bool DisconnectFromTanker(double aSimTime);

   bool DisconnectFrom(double aSimTime, WsfPlatform* aPlatformPtr);

   double CurrentSupplyRate() const { return mCurrentSupplyRate; }

   double CurrentReceiveRate() const { return mCurrentReceiveRate; }

   double GetOpBandMaximum() const { return mOperBandMaximum; }

   bool IsSupplyCapable() const { return !mStations.empty(); }

   bool IsReceiveCapable() const { return mReceiveMethod != WsfFuelingOperation::cNO_METHOD; }

   bool IsReceiveReady() const { return IsReceiveCapable() && !ReceiveInProcess(); }

   WsfFuelingOperation::MethodType ReceiveMethod() const { return mReceiveMethod; }

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

   bool BeginSupplyingFuelTo(double aSimTime, WsfTankedFuel* aReceiverPtr);

   double GetSupplyRate() const override { return mCurrentSupplyRate; }

   double GetReceiveRate() const override { return mCurrentReceiveRate; }

   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) { mSupplyMethPref = aSupplyMethod; }

   void SetSupplyLocationPreference(WsfFuelingOperation::Preference aLocationPref) { mSupplyLocPref = aLocationPref; }
 
protected:
   WsfTankedFuel(const WsfTankedFuel& aSrc);
 
   bool SetDefaultSupplyConfig();
 
   virtual double UpdateFuelingOps(double aSimTime);
 
private:
   // A collection of possible tanker fueling supply locations:
   WsfFuelingOperation::SupplyPoints mStations;
   WsfFuelingOperation::MethodType   mReceiveMethod;
   WsfFuelingOperation::MethodType   mSupplyMethPref;
   WsfFuelingOperation::Preference   mSupplyLocPref;
 
   bool mReceiveInProcess;
   bool mTankInstantly; // ignore any specified transfer rates
 
   bool mIsBelowTriggered;
   bool mIsAboveTriggered;
 
   size_t         mSupplierIndex;
   WsfTankedFuel* mSupplyTankPtr;
 
   double mLastFoUpdate;
   double mMaxReceiveRate;
 
   double mCurrentReceiveRate;
   double mCurrentSupplyRate;
 
   double mOperBandMaximum; // Desired maximum quantity obtained if refueled externally (<= Maximum + Reserve)
   double mOperBandMinimum; // Minimum "full" quantity if refueled externally (<= mOperBandMaximum)
};
 
#endif