WsfExplicitWeapon.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.
// ****************************************************************************
 
#ifndef WSFEXPLICITWEAPON_HPP
#define WSFEXPLICITWEAPON_HPP
 
#include "wsf_mil_export.h"
 
#include <list>
#include <utility>
 
#include "UtCallback.hpp"
class UtInput;
class WsfScriptContext;
#include "WsfStringId.hpp"
#include "WsfVariable.hpp"
#include "WsfWeapon.hpp"

 
class WSF_MIL_EXPORT WsfExplicitWeapon : public WsfWeapon
{
public:
   WsfExplicitWeapon(WsfScenario& aScenario);
   ~WsfExplicitWeapon() override;


 
   WsfWeapon* Clone() const override;
   bool       Initialize(double aSimTime) override;
   bool       Initialize2(double aSimTime) override;
   bool       ProcessInput(UtInput& aInput) override;
   void       TurnOff(double aSimTime) override;

 
   FireResult Fire(double aSimTime, const FireTarget& aTarget, const FireOptions& aSettings) override;
 
   void AbortSalvo(double aSimTime, const WsfTrackId& aTrackId) override;
 
   double GetQuantityRemaining() const override;
 
   double GetDeferredLaunchDelay() const { return mDeferredLaunchDelay; }

   bool GetIgnoreLaunchPlatformVelocity() const { return mIgnoreLaunchPlatformVelocity; }

   void SetIgnoreLaunchPlatformVelocity(bool aValue) { mIgnoreLaunchPlatformVelocity = aValue; }
 
   virtual void GetLaunchDeltaV(double aDV[3]) const;
   virtual void SetLaunchDeltaV(const double aLaunchDeltaV[3]);
 
   size_t LastIndexFired() const { return mLastIndexLaunched; }

   int GetOffsetId() const { return mIdOffset; }
 
   void SetOffsetId(int aOffset) { mIdOffset = aOffset; }
 
   virtual int ProcessDeferredLaunchEvent(double aSimTime, WsfPlatform* aWeaponPlatformPtr, WsfPlatform* aTempPlatformPtr);
 
   bool IsWeaponToolsGenerationMode() const { return mWeaponToolsGenMode; }
   void SetIsWeaponToolsGenerationMode(bool aValue) { mWeaponToolsGenMode = aValue; }
 
   void SetPlatform(WsfPlatform* aPlatformPtr) override;
 
   // ITAR - This functionality was refactored from the WsfMover to meet EAR99 requirements, may need moved again
   virtual bool UseDeferredLaunching() const;

   class DeferredLaunch
   {
   public:
      DeferredLaunch(WsfPlatform* aRealPlatformPtr, WsfPlatform* aTempPlatformPtr, WsfTrack* aLaunchTrackPtr);

      WsfPlatform* mRealPlatformPtr;

      WsfPlatform* mTempPlatformPtr;

      WsfTrack* mLaunchTrackPtr;
   };
 
   struct CommandChain
   {
      WsfStringId mCommandChainName;
      WsfStringId mCommanderName;
   };
 
protected:
   WsfExplicitWeapon(const WsfExplicitWeapon& aSrc);
   WsfExplicitWeapon& operator=(const WsfExplicitWeapon&) = delete;
 
   virtual bool AddWeaponToSimulation(double             aSimTime,
                                      WsfPlatform*       aWeaponPlatformPtr,
                                      const WsfTrack*    aLaunchingTrackPtr,
                                      const FireOptions& aSettings);
 
   void InitializeCommandChains(double aSimTime, WsfPlatform* aPlatformPtr);
 
   virtual void SetLaunchState(double aSimTime, WsfPlatform* aPlatformPtr, const FireOptions& aOptions);
 
   virtual bool WeaponPlatformUserInitialize(double aSimTime, WsfPlatform* aWeaponPlatformPtr, const WsfTrack* aTrackPtr);

   virtual WsfWeapon::FireResult
   FireP(double aSimTime, const FireTarget& aTarget, const FireOptions& aSettings, WsfPlatform* aWeaponPlatformPtr);
 
   WsfScriptContext* mContextPtr;

   double mLaunchDeltaV_PCS[3];

   double mDeferredLaunchDelay;

   std::vector<DeferredLaunch> mDeferredLaunches;

   size_t mLastIndexLaunched;

   int mIdOffset;
 
   std::vector<CommandChain> mCommandChains;

   bool mIgnoreLaunchPlatformVelocity;

   bool mRequireInterceptPoint;
   bool mRequireLoftAngle;
   bool mWeaponToolsGenMode;
};
 
#endif