WsfWeaponTaskManager.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 WSFWEAPONTASKMANAGER_HPP
#define WSFWEAPONTASKMANAGER_HPP
 
#include "wsf_mil_export.h"
 
#include "WsfMilComponentRoles.hpp"
#include "WsfTaskManager.hpp"
#include "WsfTaskProcessor.hpp"
class WsfTrack;
class WsfTrackId;
class WsfWeapon;
class WsfWeaponEngagement;

class WSF_MIL_EXPORT WsfWeaponTaskManager : public WsfTaskManagerComponent
{
public:
   static void                  RegisterComponentFactory(WsfScenario& aScenario);
   static WsfWeaponTaskManager* Find(const WsfProcessor& aParent);
   static WsfWeaponTaskManager* FindOrCreate(WsfProcessor& aParent);
 
   WsfWeaponTaskManager();
   WsfWeaponTaskManager(const WsfWeaponTaskManager& aSrc);
   WsfWeaponTaskManager& operator=(const WsfWeaponTaskManager&) = delete;
   ~WsfWeaponTaskManager() override                             = default;


   WsfComponent* CloneComponent() const override;
   WsfStringId   GetComponentName() const override;
   const int*    GetComponentRoles() const override;
   void*         QueryInterface(int aRole) override;


   bool Initialize(double aSimTime) override;
   bool ProcessInput(UtInput& aInput) override;


   void PlatformDeleted(WsfPlatform* aPlatformPtr) override;
   bool AcquireResource(double aSimTime, WsfTask& aTask, const WsfTrack& aTrack, bool& aStatusOk) override;
   bool ReleaseResource(double aSimTime, WsfTask& aTask) override;
   bool AssignTask(double aSimTime, const WsfTrack& aTrack, const WsfTask& aTask, bool aLockTrack = true) override;
 
   void PurgeReceivedTask(double aSimTime, WsfTask& aTask) override;
   void PurgeTransmittedTask(double aSimTime, WsfTask& aTask) override;
 
   void TaskCorrelated(double aSimTime, WsfTask& aTask) override;
   void TaskCanceled(double aSimTime, WsfTask& aTask) override;
 
   void TrackDropped(double aSimTime, const WsfTrackId& aTrackId) override;
 
   bool ProcessAssociationMessage(double aSimTime, const WsfAssociationMessage& aMessage) override;
   bool ProcessTaskStatusMessage(double aSimTime, const WsfTaskStatusMessage& aMessage) override;


   using WeaponTaskLogEntry = std::set<std::pair<size_t, WsfStringId>>;
   using WeaponTaskLogMap   = std::map<WsfTrackId, WeaponTaskLogEntry>;


   virtual bool AbortFiring(double aSimTime, const WsfTrackId& aTrackId);
 


   virtual void WeaponFireAborted(double aSimTime, WsfWeapon* aWeaponPtr, const WsfTrack* aTargetTrackPtr, double aQuantity);
 
   virtual void WeaponFired(double aSimTime, const WsfWeaponEngagement* aEngagementPtr, const WsfTrack* aTargetTrackPtr);
 
   void WeaponTerminated(double aSimTime, const WsfWeaponEngagement* aEngagementPtr);
 


   void StartingWeaponTask(double aSimTime, const WsfTask& aTask);


   double TimeWeaponLastFiredFor(const WsfTrackId& aTrackId);
   double TimeWeaponLastTerminatedFor(const WsfTrackId& aTrackId);
   int    WeaponsActiveFor(const WsfTrackId& aTrackId);
   int    WeaponsActiveFor(const WsfTrackId& aTrackId, WsfPlatform* aPlatformPtr);
   int    SalvosFiredAt(const WsfTrackId& aTrackId);
   int    RoundsFiredAt(const WsfTrackId& aTrackId);
   int    RoundsFiredAt(const WsfTrackId& aTrackId, WsfPlatform* aPlatformPtr);

   static UtCallbackListN<void(const WsfWeapon*, bool&)> IsWeaponReadyForLaunch;


   void UplinkStart(double aSimTime, unsigned int aTaskId);
 
   bool IsAutoUplink() const { return mAutoUplink; }
   // Allow the auto up-link flag to be turned off during the run.
   // BAR/AJM: Bug in auto up-link logic 06/13.  Need it off when running
   // with net logic.
   // Bug: All targets are being up-linked to the weapon and not just the
   //      current target.
   void SetAutoUplink(bool aBool) { mAutoUplink = aBool; }
 
   WsfStringId GetAutoUplinkPlatformNameId() const { return mAutoUplinkPlatform; }
 
   void SetAutoUplinkPlatformNameId(WsfStringId aAutoUplinkPlatform) { mAutoUplinkPlatform = aAutoUplinkPlatform; }
 
private:
   void BeginAutoUplink(double aSimTime, const WsfTrack& aTrack, const WsfTask& aFireTask);
 
   bool TaskWaitToTransmit(double aSimTime, const WsfTrack& aTrack, const WsfTask& aTask);

   WsfTaskManager* mTaskManagerPtr;
 
   UtCallbackHolder mCallbacks;
 
   WeaponTaskLogMap mWeaponTaskLog;

   WsfTaskManager::TaskList mWaitingTaskList;

   WsfStringId mDefaultUplinkSource;

   WsfStringId mDefaultUplinkComm;

   double mDefaultUplinkDelay;

   double mUplinkSendInterval;

   WsfStringId mAutoUplinkPlatform;

   bool mAutoUplink;
};
 
WSF_DECLARE_COMPONENT_ROLE_TYPE(WsfWeaponTaskManager, cWSF_COMPONENT_WEAPON_TASK_MANAGER)
 
#endif