WsfEW_EA_EP.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_EA_EP_HPP
#define WSFEW_EA_EP_HPP
 
#include "wsf_mil_export.h"
 
#include <map>
#include <vector>
 
class UtInput;
class WsfEM_XmtrRcvr;
#include "WsfEW_Effect.hpp"
#include "WsfEW_Technique.hpp"
#include "WsfEW_Types.hpp"
#include "WsfObject.hpp"

 
class WSF_MIL_EXPORT WsfEW_EA_EP : public WsfObject
{
public:
   WsfEW_EA_EP();
   WsfEW_EA_EP& operator=(const WsfEW_EA_EP&) = delete;
   ~WsfEW_EA_EP() override                    = default;



   WsfEW_EA_EP* Clone() const override = 0;
 
   virtual bool Initialize(WsfSimulation& aSimulation, WsfEM_XmtrRcvr* aXmtrRcvrPtr);
   bool         ProcessInput(UtInput& aInput) override;

   virtual bool DebugEnabled() const { return mDebug; }


   virtual WsfEM_XmtrRcvr& GetLinkedXmtrRcvr() const { return *mLinkedXmtrRcvrPtr; }


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


   virtual bool SetDeltaGainTechnique(double      aSimTime,
                                      WsfStringId aTechniqueId,
                                      bool        aOnOff,
                                      bool        aDebug,
                                      WsfStringId aEffectId,
                                      double      aJammingDeltaGain,
                                      WsfStringId aSystemTypeId,
                                      WsfStringId aSystemFunctionId)
   {
      return false;
   }



   virtual WsfEW_Technique::EffectPtrVec GetMitigatingEffects(const WsfEW_Effect*          aEA_EffectPtr,
                                                              WsfEW_Effect::SystemFunction aAffectingSystemFunction,
                                                              WsfEW_Effect::SystemFunction aAffectedSystemFunction);


   virtual bool AddTechnique(WsfEW_Technique* aTechniquePtr);

   bool TechniquesAreAvailable() const { return !mTechniques.empty(); }

   bool TechniquesAreInUse() const { return !mTechniquesInUse.empty(); }
 
   bool TechniqueIsAvailable(WsfEW_Types::TechniqueId aId) const;
 
   bool TechniqueIsInUse(WsfEW_Types::TechniqueId aId) const;
 
   bool TechniqueIsExternallyControlled(WsfEW_Types::TechniqueId aId) const;

   const WsfEW_Types::TechniqueIdVec& GetTechniquesAvailable() const { return mTechniques; }

   const WsfEW_Types::TechniqueIdVec& GetTechniquesInUse() const { return mTechniquesInUse; }
 
   void SetTechnique(WsfEW_Types::TechniqueId aTechniqueId, bool aOnOff);
 
   virtual WsfEW_Technique* GetTechnique(WsfEW_Types::TechniqueId aTechniqueId) const;
   virtual WsfEW_Technique* GetTechnique(unsigned int aIndex) const;
 
   void ResetTechniquesInUseList();
 
   virtual bool SelectTechnique(unsigned int aIndex);
   virtual bool SelectTechnique(WsfEW_Types::TechniqueId aId);
   virtual bool DeselectTechnique(unsigned int aIndex);
   virtual bool DeselectTechnique(WsfEW_Types::TechniqueId aId);
 
   virtual bool CanApplyTechnique(WsfEW_Types::TechniqueId aId, WsfEW_Effect::SystemFunction aSystemFunction) const;
 
   virtual WsfEW_Types::TechniqueIdVec* GetMitigatedTechniques() { return nullptr; }


   bool HasFrequencyAgilityEffect() const;
 
   bool EffectIsAvailable(WsfStringId aEffectNameId) const;
   bool EffectIsAvailable(WsfEW_Types::TechniqueId aTechId, WsfStringId aEffectNameId) const;
 
   virtual WsfEW_Effect* GetEffect(WsfEW_Types::TechniqueId aTechId, unsigned int aIndex) const;
   virtual WsfEW_Effect* GetEffect(WsfEW_Types::TechniqueId aTechId, WsfStringId aEffectId) const;
 
   virtual const WsfEW_Technique::EffectPtrVec& GetEffects(WsfEW_Types::TechniqueId aId) const;
 
   WsfSimulation* GetSimulation() const;
 
protected:
   WsfEW_EA_EP(const WsfEW_EA_EP& aSrc);
 
   bool PrivateSetTechnique(WsfEW_Types::TechniqueId aTechnique, bool aOnOff);
 
   WsfSimulation*              mSimulationPtr;
   WsfEW_Types::TechniqueIdVec mTechniques;        
   WsfEW_Types::TechniqueIdVec mTechniquesInUse;   
   bool                        mDebug;             
   WsfEM_XmtrRcvr*             mLinkedXmtrRcvrPtr; 
};
 
#endif