WsfEW_Technique.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 WSFEW_TECHNIQUE_HPP
#define WSFEW_TECHNIQUE_HPP
 
#include "wsf_mil_export.h"
 
#include <map>
#include <vector>
 
class UtInput;
class UtInputBlock;
class WsfEW_EA;
class WsfEW_EP;
class WsfEW_EA_EP;
#include "WsfEW_Effect.hpp"
#include "WsfEW_Types.hpp"
#include "WsfObject.hpp"

 
class WSF_MIL_EXPORT WsfEW_Technique : public WsfObject
{
public:
   using EffectPtrVec = std::vector<WsfEW_Effect*>;
 
   WsfEW_Technique();
   WsfEW_Technique& operator=(const WsfEW_Technique&) = delete;
   ~WsfEW_Technique() override;



   WsfEW_Technique* Clone() const override;
 
   virtual bool Initialize(WsfSimulation& aSimulation);
   bool         ProcessInput(UtInput& aInput) override;
 


 
   virtual void RemoveJammerXmtr(unsigned int aXmtrId);
   virtual void RemoveJammerXmtr(WsfEM_Xmtr* aXmtrPtr);



   void SetEA_EP_Ptr(WsfEW_EA_EP* aEA_Ptr) { mEA_EP_Ptr = aEA_Ptr; }

   WsfEW_EA_EP* GetEA_EP_Ptr() const { return mEA_EP_Ptr; }

   WsfEW_EA* GetEA_Ptr() const;

   WsfEW_EP* GetEP_Ptr() const;



   void SetDefaultOn(bool aDefaultOn) { mDefaultOn = aDefaultOn; }

   bool IsDefaultOn() const { return mDefaultOn; }

   virtual bool IsExternallyControlled() const { return false; }

   void SetDebug(bool aDebug) { mDebug = aDebug; }

   bool DebugEnabled() const { return mDebug; }


 
   bool AddEffect(WsfEW_Effect* aEffectPtr);
 
   bool EffectIsAvailable(WsfStringId aEffectNameId) const;
 
   unsigned int GetEffectCount() { return static_cast<unsigned int>(mEffects.size()); }
 
   WsfEW_Effect* GetEffect(unsigned int aIndex) const;
   WsfEW_Effect* GetEffect(WsfStringId aEffectNameId) const;
 
   const EffectPtrVec& GetEffects() const { return mEffects; }
 
   WsfEW_Effect* SelectUnmitigatedEffect(unsigned int aSystemFunctionMask);
   WsfEW_Effect* SelectUnmitigatedEffect(unsigned int aIndex, unsigned int aSystemFunctionMask);
 
   bool SetDeltaGainEffect(double      aSimTime,
                           WsfStringId aEffectId,
                           bool        aDebug,
                           double      aJammingPowerGain,
                           WsfStringId aSystemTypeId,
                           WsfStringId aSystemFunctionID);
 
   bool HasFrequencyAgilityEffect() const;



   bool CanApplyTechnique(unsigned int aSystemFunctionMask) const;

   virtual std::vector<WsfEW_Types::TechniqueId>* GetMitigatedTechniqueIds() { return nullptr; }

   virtual std::vector<WsfEW_Types::TechniqueId>* GetMitigatedTechniqueClassIds() { return nullptr; }

   virtual WsfStringId GetMitigationClassId() const { return WsfStringId(); }
 
protected:
   WsfEW_Technique(const WsfEW_Technique& aSrc);
 
   bool FindEffectIndex(WsfStringId aEffectNameId, unsigned int& aIndex) const;
 
private:
   void SelectDefaultUnmitigatedEffects(EffectPtrVec aEffectList, unsigned int aSystemFunctionMask);
 
   bool         mDebug;     
   EffectPtrVec mEffects;   
   bool         mDefaultOn; 
   WsfEW_EA_EP* mEA_EP_Ptr; 
};
 
#endif