WsfImplicitWeapon.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 WSFIMPLICITWEAPON_HPP
#define WSFIMPLICITWEAPON_HPP
 
#include "wsf_mil_export.h"
 
#include <map>
 
#include "WsfEvent.hpp"
#include "WsfStringId.hpp"
#include "WsfWeapon.hpp"

class WSF_MIL_EXPORT WsfImplicitWeapon : public WsfWeapon
{
public:
   WsfImplicitWeapon(const WsfScenario& aScenario);
   ~WsfImplicitWeapon() override;
 
   WsfWeapon* Clone() const override;
 
   bool Initialize(double aSimTime) override;
 
   void Update(double aSimTime) override;
 
   const char* GetScriptClassName() const override;
 
   WsfStringId GetTargetName() const;
 
   WsfStringId GetTargetOffset() const;
 
   WsfWeaponEngagement* GetCurrentEngagement() const;
 
   void ClearCurrentEngagement(double aSimTime);
 
   WsfWeaponEngagement* GetEngagement(int aEngagementId = 0) const; // Default argument provided to maintain backward compatibility.
 
   void ClearEngagement(double aSimTime,
                        int    aEngagementId = 0); // Default argument provided to maintain backward compatibility.
 
   FireResult Fire(double aSimTime, const FireTarget& aTarget, const FireOptions& aSettings) override;
 
   void CeaseFire(double aSimTime) override;

   class EngagementData
   {
   public:
      EngagementData() = default;
      EngagementData(const EngagementData& aSrc);
      EngagementData& operator=(const EngagementData&) = delete;
      ~EngagementData();
 
      WsfStringId               mTargetName{""};
      size_t                    mTargetIndex{0};
      WsfStringId               mTargetOffset{""};
      std::unique_ptr<WsfTrack> mTargetTrackPtr{nullptr};
      WsfWeaponEngagement*      mEngagementPtr{nullptr};
      int                       mEngagementId{0};
      bool                      mTerminateSet{false};
   };
 
   class TerminateEngagementEvent : public WsfEvent
   {
   public:
      TerminateEngagementEvent() = default;
      TerminateEngagementEvent(double             aSimTime,
                               size_t             aWeaponPlatformIndex,
                               WsfImplicitWeapon* aImplicitWeaponPtr,
                               EngagementData*&   aEngagementDataPtr);
 
      EventDisposition Execute() override;
 
   private:
      size_t             mWeaponPlatformIndex{0};
      WsfImplicitWeapon* mWeaponPtr{nullptr}; // only valid if the firing platform,
                                              // retrieved from mWeaponPlatformIndex, is valid.
      EngagementData* mEngagementDataPtr{nullptr};
   };
 
protected:
   WsfImplicitWeapon(const WsfImplicitWeapon& aSrc);
   WsfImplicitWeapon& operator=(const WsfImplicitWeapon&) = delete;
 
   void DeleteEngagementData(EngagementData* aEngagementDataPtr);
 
   bool BeginEngagement(double aSimTime, EngagementData* aEngagementDataPtr);
 
   void EngagementComplete(double aSimTime, WsfWeaponEngagement* aEngagementPtr) override;
 
   friend class TerminateEngagementEvent;
 
private:
   using EngagementDataMap = std::map<int, EngagementData*>;
 
   EngagementDataMap mEngagementDataMap;        // Map of engagement serial ids to engagement data.
   EngagementData*   mCurrentEngagementDataPtr; // In case only one engagement occurs at a time.
};
#endif