#include <WsfEW_SLC_DegradeEffect.hpp>

Inheritance diagram for WsfEW_SLC_DegradeEffect:

[legend]

Collaboration diagram for WsfEW_SLC_DegradeEffect:

[legend]

Classes
class	SLC_DegradeData

Public Types
enum	SLC_DegradeEffect { cPME_DEGRADE_SLC = 1 , cPME_SATURATE_SLC = cPME_DEGRADE_SLC << 1 }
Public Types inherited from WsfEW_RepeaterEffect
enum	ControlMethod { cCM_NONE = 1 , cCM_USE_REPEATER = cCM_NONE << 1 , cCM_USE_ACTUALS = cCM_NONE << 2 , cCM_USE_REPEATER_ACTUALS = cCM_NONE << 3 }
enum	GainControlType { cMG_NONE = 1 , cMG_DESIRED_RCS = cMG_NONE << 1 , cMG_MIN_J_TO_N = cMG_NONE << 2 , cMG_MIN_J_TO_S = cMG_NONE << 3 , cMG_MIN_DETECT = cMG_NONE << 4 , cMG_MASKING = cMG_NONE << 5 }
Public Types inherited from WsfEW_RadiusEffect
enum	RadiusLimitType { cJRL_NONE = 0 , cJRL_INSIDE = 1 , cJRL_OUTSIDE = 2 , cJRL_BOTH = 3 , cJRL_EQUAL = 4 }
using	RadiusTypeToValueMap = std::map<RadiusLimitType, double>
Public Types inherited from WsfEW_Effect
enum	Behavior { cEB_UNDEFINED = 1 , cEB_DROP_TRACK = cEB_UNDEFINED << 1 , cEB_MAINTAIN_TRACK = cEB_UNDEFINED << 2 , cEB_TRACK_ERROR = cEB_UNDEFINED << 3 , cEB_DROP_MESSAGE = cEB_UNDEFINED << 4 , cEB_MAINTAIN_MESSAGE = cEB_UNDEFINED << 5 , cEB_MESSAGE_ERROR = cEB_UNDEFINED << 6 , cEB_JAMMER_POWER_EFFECT = cEB_UNDEFINED << 7 , cEB_SIGNAL_POWER_EFFECT = cEB_UNDEFINED << 8 , cEB_SLC_DEGRADE_EFFECT = cEB_UNDEFINED << 9 , cEB_FALSE_TARGET_EFFECT = cEB_UNDEFINED << 10 , cEB_PULSE_EFFECT = cEB_UNDEFINED << 11 , cEB_AGILITY_EFFECT = cEB_UNDEFINED << 12 , cEB_REPEATER_EFFECT = cEB_UNDEFINED << 13 , cEB_REPEATER_UPDATE = cEB_UNDEFINED << 14 , cEB_FLOODED_BLOCKED = cEB_UNDEFINED << 15 , cEB_FLOODED_MAINTAINED = cEB_UNDEFINED << 16 , cEB_JAM_STROBE_EFFECT = cEB_UNDEFINED << 17 , cEB_TARGET_REJECT_EFFECT = cEB_UNDEFINED << 18 , cEB_NEXT_FREE_MASK = cEB_UNDEFINED << 19 }
	The behavior the EW effect exhibits. More...
enum	Coherency { cEC_NONE = 1 , cEC_NONCOHERENT = cEC_NONE << 1 , cEC_COHERENT = cEC_NONE << 2 , cEC_NONCOHERENT_PULSE = cEC_NONE << 3 , cEC_COHERENT_PULSE = cEC_NONE << 4 }
	The signal coherency the EW effect exhibits on the affected system. More...
enum	ModulationType { cEM_NONE = 1 , cEM_CW = cEM_NONE << 1 , cEM_COHPULSE = cEM_NONE << 2 , cEM_NONCOHPULSE = cEM_NONE << 3 , cEM_LINEARFM = cEM_NONE << 4 , cEM_NONLINEARFM = cEM_NONE << 5 , cEM_PHASEKEY = cEM_NONE << 6 , cEM_PHASEMOD = cEM_NONE << 7 , cEM_PHASECODE = cEM_NONE << 8 , cEM_ASK = cEM_NONE << 9 , cEM_FSK = cEM_NONE << 10 , cEM_PSK = cEM_NONE << 11 , cEM_BPSK = cEM_NONE << 12 , cEM_QPSK = cEM_NONE << 13 , cEM_DPSK = cEM_NONE << 14 , cEM_QAM = cEM_NONE << 15 }
enum	TargetProtectionType { cTP_ALL , cTP_NON_SELF_PROTECT , cTP_SELF_PROTECT }
	The target protection type this effect is limited to. More...
enum	SystemFunction { cES_UNDEFINED = 1 , cES_COMM = cES_UNDEFINED << 1 , cES_SENSOR = cES_UNDEFINED << 2 , cES_JAMMER = cES_UNDEFINED << 3 , cES_NEXT_FREE_MASK = cES_UNDEFINED << 4 }
	The type of system function types the EW effect can affect. More...
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfEW_SLC_DegradeEffect ()
WsfEW_SLC_DegradeEffect &	operator= (const WsfEW_SLC_DegradeEffect &)=delete
	~WsfEW_SLC_DegradeEffect () override=default
WsfEW_Effect *	Clone () const override
bool	Initialize (WsfSimulation &aSimulation) override
bool	ProcessInput (UtInput &aInput) override
void	ApplyUnmitigatedEffect (WsfEW_Effects &aEW_Effects) const override
void	ApplyMitigatedEffect (WsfEW_Effect *aEW_EffectPtr, WsfEW_Effects &aEW_Effects) const override
Public Member Functions inherited from WsfEW_PowerEffect
	WsfEW_PowerEffect ()
WsfEW_PowerEffect &	operator= (const WsfEW_PowerEffect &)=delete
	~WsfEW_PowerEffect () override=default
void	UpdateEffects (double aSimTime, const WsfEM_Interaction &aTargetInteraction, const WsfEM_Interaction &aJammerToTgtInteraction, const ut::optional< WsfEM_Interaction > &aTgtToJammerInteraction, WsfEW_Effects &aEW_Effects, WsfEW_Effect *aEW_EffectPtr=nullptr) override
double	GetJammingPowerGain (WsfStringId aSystemTypeId) const
void	SetJammingPowerGain (WsfStringId aSystemTypeId, double aJammingPowerGain)
double	GetModulationGain (WsfStringId aSystemTypeId) const
void	SetModulationGain (WsfStringId aSystemTypeId, double aModulaitonGain)
double	GetSignalPowerGain (WsfStringId aSystemTypeId) const
void	SetSignalPowerGain (WsfStringId aSystemTypeId, double aSignalPowerGain)
double	GetRcvrNoiseGain (WsfStringId aSystemTypeId) const
void	SetRcvrNoiseGain (WsfStringId aSystemTypeId, double aRcvrNoiseGain)
double	GetJtoSGain (WsfStringId aSystemTypeId, Coherency aCoherencyType=cEC_NONE) const
size_t	GetJtoSTableSize (WsfStringId aSystemTypeId) const
Public Member Functions inherited from WsfEW_RepeaterEffect
	WsfEW_RepeaterEffect ()
WsfEW_RepeaterEffect &	operator= (const WsfEW_RepeaterEffect &)=delete
	~WsfEW_RepeaterEffect () override=default
void	UpdateEffects (double aSimTime, const WsfEM_Interaction &aTargetInteraction, const WsfEM_Interaction &aJammerToTgtInteraction, const ut::optional< WsfEM_Interaction > &aTgtToJammerInteraction, WsfEW_Effects &aEW_Effects, WsfEW_Effect *aEW_EffectPtr=nullptr) override
ControlMethod	GetControlMethod (WsfStringId aSystemTypeId) const
void	SetControlMethod (WsfStringId aSystemTypeId, ControlMethod aControlMethod)
double	GetMinimumGainFactor (WsfStringId aSystemTypeId) const
double	GetMaximumGainFactor (WsfStringId aSystemTypeId) const
void	SetGainFactors (WsfStringId aSystemTypeId, double aMinimumGainFactor, double aMaximumGainFactor)
int	GetGainControlTypeMask (WsfStringId aSystemTypeId) const
double	GetDesiredJtoN (WsfStringId aSystemTypeId) const
void	SetDesiredJtoN (WsfStringId aSystemTypeId, double aDesiredJtoN)
double	GetDesiredJtoS (WsfStringId aSystemTypeId) const
void	SetDesiredJtoS (WsfStringId aSystemTypeId, double aDesiredJtoS)
double	GetDesiredFT_RCS (WsfStringId aSystemTypeId) const
void	SetDesiredFT_RCS (WsfStringId aSystemTypeId, double aDesiredFT_MaskingRCS)
double	GetMinDetectFactor (WsfStringId aSystemTypeId) const
void	SetMinDetectFactor (WsfStringId aSystemTypeId, double aMinDetectFactor)
double	GetMaskingFactor (WsfStringId aSystemTypeId) const
void	SetMaskingFactor (WsfStringId aSystemTypeId, double aMaskingFactor)
Public Member Functions inherited from WsfEW_RadiusEffect
	WsfEW_RadiusEffect ()
WsfEW_RadiusEffect &	operator= (const WsfEW_RadiusEffect &)=delete
	~WsfEW_RadiusEffect () override=default
int	GetRadiusLimitMask (WsfStringId aSystemTypeId) const
double	GetRadiusFactor (WsfStringId aSystemTypeId) const
double	GetRadiusFactor (WsfStringId aSystemTypeId, RadiusLimitType aJRL_Type) const
Public Member Functions inherited from WsfEW_Effect
	WsfEW_Effect ()=default
WsfEW_Effect &	operator= (const WsfEW_Effect &)=delete
	~WsfEW_Effect () override
virtual void	ProcessUnmitigatedEffect (double aSimTime, const WsfEM_Interaction &aTargetInteraction, const WsfEM_Interaction &aJammerToTgtInteraction, const ut::optional< WsfEM_Interaction > &aTgtToJammerInteraction, WsfEW_Effects &aEW_Effects)
virtual void	ProcessMitigatedEffect (double aSimTime, const WsfEM_Interaction &aTargetInteraction, const WsfEM_Interaction &aJammerToTgtInteraction, const ut::optional< WsfEM_Interaction > &aTgtToJammerInteraction, WsfEW_Effects &aEW_Effects, WsfEW_Effect *aEW_EffectPtr=nullptr)
virtual void	RemoveJammerXmtr (unsigned int aXmtrId)
virtual void	RemoveJammerXmtr (WsfEM_Xmtr *aJammerXmtrPtr)
void	SetSystemFunctionMask (SystemFunction aSystemFunction)
	Set the system type.
void	SetSystemFunctionMask (const std::string &aSystemFunctionId)
void	AddSystemFunctionMask (SystemFunction aSystemFunction)
	Set the system type.
void	AddSystemFunctionMask (const std::string &aSystemFunctionId)
unsigned int	GetSystemFunctionMask () const
void	SetCoherencyMask (Coherency aCoherency)
void	AddCoherencyMask (Coherency aCoherency)
unsigned int	GetCoherencyMask () const
void	SetBehavior (Behavior aBehavior)
Behavior	GetBehavior () const
void	SetDebug (bool aDebug)
bool	DebugEnabled () const
void	SetEA_EP_Ptr (WsfEW_EA_EP *aPtr)
WsfEW_EA_EP *	GetEA_EP_Ptr () const
WsfEW_EA *	GetEA_Ptr () const
WsfEW_EP *	GetEP_Ptr () const
WsfEW_Technique *	GetTechniquePtr () const
void	SetTechniquePtr (WsfEW_Technique *aPtr)
virtual double	GetJammingPulseDensity () const
virtual double	GetJammingPulseDensity (WsfEM_Xmtr *aXmtrPtr) const
virtual bool	AllowTarget (WsfPlatform aXmtrPlatform, WsfPlatform aTargetPlatform) const
virtual void	UpdateCurrentIds (WsfEM_Rcvr aRcvrPtr, WsfEM_Xmtr aXmtrPtr, WsfPlatform *aTargetPtr)
WsfSimulation *	GetSimulation () const
ut::Random &	GetRandom ()
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Effect Data methods.
	WsfEW_SLC_DegradeEffect (const WsfEW_SLC_DegradeEffect &aSrc)
EffectData *	NewEffectData () override
EffectData *	PropagateEffectDataPtr (WsfStringId aSystemTypeId) override

SLC Degradation Accessor/Mutator methods.
double	GetSLC_DegradationValue (WsfStringId aSystemTypeId) const
int	GetSLC_ChannelsSaturated (WsfStringId aSystemTypeId) const

Additional Inherited Members
static WsfEW_Effect::SystemFunction	ConvertToEW_SystemFunction (WsfEM_Rcvr::RcvrFunction aRcvrFunction)
static WsfEW_Effect::SystemFunction	ConvertToEW_SystemFunction (WsfEM_Xmtr::XmtrFunction aXmtrFunction)
static unsigned int	ConvertCoherencyIdToMask (WsfStringId aCoherencyId)
using	EffectDataMap = std::map<WsfStringId, EffectData*>
	WsfEW_PowerEffect (const WsfEW_PowerEffect &aSrc)
	WsfEW_RepeaterEffect (const WsfEW_RepeaterEffect &aSrc)
double	GetRepeaterFactor ()
	Get the current repeater factor for last call to UpdateEffects(...) or UpdateRepeaterFactor(...).
void	UpdateGainFactors (const WsfEM_Interaction &aTargetInteraction, const WsfEM_Interaction &aJammerToTgtInteraction, const ut::optional< WsfEM_Interaction > &aTgtToJammerInteraction, double aCurrentGains[])
	WsfEW_RadiusEffect (const WsfEW_RadiusEffect &aSrc)
bool	ProcessEffectDataBlock (UtInputBlock &aInputBlock, WsfStringId aSystemTypeId)
virtual EffectData &	GetEffectData (WsfStringId aSystemTypeId)
void	ResetEffectData (WsfStringId aSystemTypeId)
bool	EffectDataExists (WsfStringId aSystemTypeId) const
void	InsertNewEffectData (WsfStringId aSystemTypeId, WsfEW_Types::EW_EffectData *aEffectPtr)
	WsfEW_Effect (const WsfEW_Effect &aSrc)
virtual void	PrintUpdateMessage (ut::log::MessageStream &aStream, double aSimTime, WsfEW_Effect *aEW_EffectPtr=nullptr)
void	ResetProtectionTypeFlag (WsfEM_Xmtr *aXmtrPtr, const WsfEM_Interaction &aTargetInteraction, WsfEW_Effects &aEW_Effects)
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
unsigned int	mSystemFunctionMask {cES_UNDEFINED}
	The system type mask that this EW effect can affect.
Behavior	mBehavior {cEB_UNDEFINED}
	The behavior that this EW effect exhibits.
unsigned int	mCoherencyMask {cEC_NONE}
	The coherency of this effect wrt to the affected system.
bool	mDebug {false}
	The debug flag, 'true' for debug, false otherwise.
WsfStringId	mCurrentTargetId {nullptr}
	Current target Id.
WsfStringId	mCurrentXmtrPlatformId {nullptr}
	Current transmitting platform Id.
WsfStringId	mCurrentRcvrPlatformId {nullptr}
	Current receiving platform Id.
int	mCurrentXmtrUniqueId {0}
	Current transmitter unique Id.
int	mCurrentRcvrUniqueId {0}
	Current receiver unique Id.
WsfStringId	mEffectedSystemId {nullptr}
	The type Id of the system being effected, changes with each call to UpdateEffects(...) or UpdateCurrentIds(...).
WsfStringId	mEffectingSystemId {nullptr}
	The type Id of the system doing the effecting, changes with each call to UpdateEffects(...) or UpdateCurrentIds(...).
bool	mUpdatingEffect {true}
	Variable to prevent infinite recursion in UpdateEffect.
EffectDataMap	mEffectDataMap
	Map of the System Type Id to the data required for this effect.

Member Enumeration Documentation

◆ SLC_DegradeEffect

enum WsfEW_SLC_DegradeEffect::SLC_DegradeEffect

Enumerator
cPME_DEGRADE_SLC
cPME_SATURATE_SLC

Constructor & Destructor Documentation

◆ WsfEW_SLC_DegradeEffect() [1/2]

WsfEW_SLC_DegradeEffect::WsfEW_SLC_DegradeEffect ( )

References WsfEW_Effect::cEB_SLC_DEGRADE_EFFECT, WsfEW_Effect::cEC_NONCOHERENT, WsfEW_Effect::mBehavior, WsfEW_Effect::mCoherencyMask, and WsfEW_PowerEffect::WsfEW_PowerEffect().

Referenced by Clone(), operator=(), WsfEW_PolModEffect::WsfEW_PolModEffect(), WsfEW_PolModEffect::WsfEW_PolModEffect(), and WsfEW_SLC_DegradeEffect().

◆ ~WsfEW_SLC_DegradeEffect()

WsfEW_SLC_DegradeEffect::~WsfEW_SLC_DegradeEffect ( )

overridedefault

References GetSLC_ChannelsSaturated(), and GetSLC_DegradationValue().

◆ WsfEW_SLC_DegradeEffect() [2/2]

WsfEW_SLC_DegradeEffect::WsfEW_SLC_DegradeEffect ( const WsfEW_SLC_DegradeEffect & aSrc )

protected

References WsfEW_PowerEffect::WsfEW_PowerEffect(), and WsfEW_SLC_DegradeEffect().

Member Function Documentation

◆ ApplyMitigatedEffect()

void WsfEW_SLC_DegradeEffect::ApplyMitigatedEffect	(	WsfEW_Effect *	aEW_EffectPtr,
		WsfEW_Effects &	aEW_Effects ) const

overridevirtual

Reimplemented from WsfEW_PowerEffect.

References WsfEW_PowerEffect::ApplyMitigatedEffect().

Referenced by WsfEW_PolModEffect::ApplyMitigatedEffect().

◆ ApplyUnmitigatedEffect()

void WsfEW_SLC_DegradeEffect::ApplyUnmitigatedEffect ( WsfEW_Effects & aEW_Effects ) const

overridevirtual

Reimplemented from WsfEW_PowerEffect.

References WsfEW_PowerEffect::ApplyUnmitigatedEffect(), WsfEW_Effect::cEB_SLC_DEGRADE_EFFECT, WsfEW_Effect::mDebug, and WsfEW_Effects::mMask.

Referenced by WsfEW_PolModEffect::ApplyUnmitigatedEffect().

◆ Clone()

WsfEW_Effect * WsfEW_SLC_DegradeEffect::Clone ( ) const

overridevirtual

Clone this object.

Returns: a pointer to the new object.

Reimplemented from WsfEW_PowerEffect.

References WsfEW_SLC_DegradeEffect().

◆ GetSLC_ChannelsSaturated()

int WsfEW_SLC_DegradeEffect::GetSLC_ChannelsSaturated ( WsfStringId aSystemTypeId ) const

Referenced by WsfEW_SLC_Effect::UpdateEffects(), and ~WsfEW_SLC_DegradeEffect().

◆ GetSLC_DegradationValue()

double WsfEW_SLC_DegradeEffect::GetSLC_DegradationValue ( WsfStringId aSystemTypeId ) const

Referenced by WsfEW_SLC_Effect::UpdateEffects(), and ~WsfEW_SLC_DegradeEffect().

◆ Initialize()

bool WsfEW_SLC_DegradeEffect::Initialize ( WsfSimulation & aSimulation )

overridevirtual

Reimplemented from WsfEW_PowerEffect.

References WsfEW_Effect::cES_SENSOR, WsfEW_Effect::GetEA_Ptr(), WsfEW_PowerEffect::Initialize(), WsfEW_Effect::mSystemFunctionMask, and ok.

Referenced by WsfEW_PolModEffect::Initialize().

◆ NewEffectData()

WsfEW_SLC_DegradeEffect::EffectData * WsfEW_SLC_DegradeEffect::NewEffectData ( )

overrideprotectedvirtual

Reimplemented from WsfEW_PowerEffect.

◆ operator=()

WsfEW_SLC_DegradeEffect & WsfEW_SLC_DegradeEffect::operator= ( const WsfEW_SLC_DegradeEffect & )

delete

References WsfEW_SLC_DegradeEffect().

◆ ProcessInput()

bool WsfEW_SLC_DegradeEffect::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfEW_PowerEffect.

References WsfEW_PowerEffect::ProcessInput().

Referenced by WsfEW_PolModEffect::ProcessInput().

◆ PropagateEffectDataPtr()

WsfEW_Effect::EffectData * WsfEW_SLC_DegradeEffect::PropagateEffectDataPtr ( WsfStringId aSystemTypeId )

overrideprotectedvirtual

Local copy of the mEffectDataMap to prevent casting within this class.

Reimplemented from WsfEW_PowerEffect.

References WsfEW_PowerEffect::PropagateEffectDataPtr().

Referenced by WsfEW_PolModEffect::PropagateEffectDataPtr().

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Effect Data methods.

SLC Degradation Accessor/Mutator methods.

Additional Inherited Members

Member Enumeration Documentation

◆ SLC_DegradeEffect

Constructor & Destructor Documentation

◆ WsfEW_SLC_DegradeEffect() [1/2]

◆ ~WsfEW_SLC_DegradeEffect()

◆ WsfEW_SLC_DegradeEffect() [2/2]

Member Function Documentation

◆ ApplyMitigatedEffect()

◆ ApplyUnmitigatedEffect()

◆ Clone()

◆ GetSLC_ChannelsSaturated()

◆ GetSLC_DegradationValue()

◆ Initialize()

◆ NewEffectData()

◆ operator=()

◆ ProcessInput()

◆ PropagateEffectDataPtr()