WsfFuelingOperation.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 WSFFUELINGOPERATION_HPP
#define WSFFUELINGOPERATION_HPP
 
#include "wsf_export.h"
 
#include <string>
#include <vector>
 
class WsfTankedFuel;

class WSF_EXPORT WsfFuelingOperation
{
public:
   static bool AllowSimultWingAndCenterlineFueling();
   static void SetAllowSimultWingAndCenterlineFueling(bool aValue);

   static bool AllowSimultBoomAndHoseFueling();
   static void SetAllowSimultBoomAndHoseFueling(bool aValue);

   enum MethodType
   {
      cNO_METHOD = 0, 
      cBOOM      = 1, 
      cHOSE      = 2  
   };

   enum Preference
   {
      cNO_PREFERENCE = 0, 
      cCHOOSE_CENTER = 1, 
      cCHOOSE_WING   = 2  
   };

   enum StationType
   {
      cNO_STATION = 0, 
      cLEFT_WING  = 1, 
      cCENTERLINE = 2, 
      cRIGHT_WING = 3  
   };
 
   // static unsigned int GetUInt(StationType aStation);
 
   // Constructors/Destructor
   WsfFuelingOperation();
   WsfFuelingOperation(double         aSimTime,
                       WsfTankedFuel* aSupplierPtr,
                       WsfTankedFuel* aReceiverPtr,
                       MethodType     aMethod,
                       StationType    aStation,
                       double         aInitRate);
   WsfFuelingOperation(const WsfFuelingOperation& aSrc) = delete;
   virtual ~WsfFuelingOperation();
 
   virtual double Update(double aSimTime, bool& aDisconnected);

   double GetTransferRate() const { return mXferRate; }

   double FuelTransferred() const { return mCumFuelXfer; }

   double FuelingTime() const { return mLastUpdate - mStartFuelTime; }

   double LastUpdate() const { return mLastUpdate; }

   WsfTankedFuel* SupplyTankPtr() const { return mSupplierPtr; }

   WsfTankedFuel* ReceiveTankPtr() const { return mReceiverPtr; }

   MethodType GetMethod() const { return mMethod; }
 
   std::string GetMethodName() const;
   std::string GetStationName() const;
 
   struct SupplyPoint
   {
      SupplyPoint() = default;
 
      SupplyPoint(MethodType& aMethod, StationType& aStation, double aRate = 0.0)
         : mMethod(aMethod)
         , mStation(aStation)
         , mOpPtr(nullptr)
         , mConstRate(aRate)
      {
      }
 
      std::string GetMethodName() const;
      std::string GetStationName() const;
 
      MethodType           mMethod{cNO_METHOD};
      StationType          mStation{cNO_STATION};
      WsfFuelingOperation* mOpPtr{nullptr};
      double               mConstRate{0.0};
   };
 
   using SupplyPoints         = std::vector<SupplyPoint>;
   using SupplyPointIter      = std::vector<SupplyPoint>::iterator;
   using SupplyPointConstIter = std::vector<SupplyPoint>::const_iterator;
 
protected:
   virtual double CalcInitXferRate(double aSimTime) { return mXferRate; }
   virtual double CalcRunXferRate(double aSimTime) { return mXferRate; }
 
private:
   void DisconnectP(double aSimTime);
 
   WsfTankedFuel* mSupplierPtr;
   WsfTankedFuel* mReceiverPtr;
   double         mStartFuelTime;
   double         mLastUpdate; // Will also represent mLastFuelTime after termination.
   double         mXferRate;
   double         mCumFuelXfer;
   bool           mCmdDisconnect; // This flag allows for the Receiver to terminate early.
   bool           mInternalDisc;
   MethodType     mMethod;
   StationType    mStation;
};
 
#endif