#include <WsfEW_RadiusEffect.hpp>

Inheritance diagram for WsfEW_RadiusEffect:

[legend]

Collaboration diagram for WsfEW_RadiusEffect:

[legend]

Classes
class	RadiusData

Public Types
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_RadiusEffect ()
WsfEW_RadiusEffect &	operator= (const WsfEW_RadiusEffect &)=delete
	~WsfEW_RadiusEffect () 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
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
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.
EffectData *	NewEffectData () override
EffectData *	PropagateEffectDataPtr (WsfStringId aSystemTypeId) override

Delta gain effect Accessor/Mutator methods.
int	GetRadiusLimitMask (WsfStringId aSystemTypeId) const
double	GetRadiusFactor (WsfStringId aSystemTypeId) const
double	GetRadiusFactor (WsfStringId aSystemTypeId, RadiusLimitType aJRL_Type) const
	WsfEW_RadiusEffect (const WsfEW_RadiusEffect &aSrc)

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*>
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.

Detailed Description

WsfEW_RadiusEffect models and applies delta gain effects to the jammer power.

Can be associated with an EA or EP technique to increase or decrease the jammer power by a factor.

Member Typedef Documentation

◆ RadiusTypeToValueMap

using WsfEW_RadiusEffect::RadiusTypeToValueMap = std::map<RadiusLimitType, double>

Member Enumeration Documentation

◆ RadiusLimitType

enum WsfEW_RadiusEffect::RadiusLimitType

Enumeration for the type of limitation that is imposed Defines the target range wrt to the jammer range relative to the receiver

Enumerator
cJRL_NONE	No target jammer range limitations defined.
cJRL_INSIDE	Limitation for target range INSIDE jammer range wrt receiver.
cJRL_OUTSIDE	Limitation for target range OUTSIDE jammer range wrt receiver.
cJRL_BOTH	Limitation for target range INSIDE & OUTSIDE jammer range wrt to receiver.
cJRL_EQUAL	Limitation for target range EQUAL to jammer range wrt receiver.

Constructor & Destructor Documentation

◆ WsfEW_RadiusEffect() [1/2]

WsfEW_RadiusEffect::WsfEW_RadiusEffect ( )

References WsfEW_Effect::cEB_JAMMER_POWER_EFFECT, WsfEW_Effect::cEC_NONE, cJRL_NONE, WsfEW_Effect::mBehavior, WsfEW_Effect::mCoherencyMask, and WsfEW_Effect::WsfEW_Effect().

Referenced by Clone(), operator=(), WsfEW_RadiusEffect(), WsfEW_RepeaterEffect::WsfEW_RepeaterEffect(), and WsfEW_RepeaterEffect::WsfEW_RepeaterEffect().

◆ ~WsfEW_RadiusEffect()

WsfEW_RadiusEffect::~WsfEW_RadiusEffect ( )

overridedefault

References GetRadiusFactor(), GetRadiusLimitMask(), and WsfEW_Effect::WsfEW_Effect().

◆ WsfEW_RadiusEffect() [2/2]

WsfEW_RadiusEffect::WsfEW_RadiusEffect ( const WsfEW_RadiusEffect & aSrc )

protected

References WsfEW_Effect::WsfEW_Effect(), and WsfEW_RadiusEffect().

Member Function Documentation

◆ ApplyMitigatedEffect()

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

overridevirtual

◆ ApplyUnmitigatedEffect()

void WsfEW_RadiusEffect::ApplyUnmitigatedEffect ( WsfEW_Effects & aEW_Effects ) const

overridevirtual

◆ Clone()

WsfEW_Effect * WsfEW_RadiusEffect::Clone ( ) const

overridevirtual

Clone this object.

Returns: a pointer to the new object.

Implements WsfEW_Effect.

Reimplemented in WsfEW_RepeaterEffect, WsfEW_RPJ_Effect, WsfEW_SimpleFT_Effect, WsfEW_SLB_Effect, WsfEW_SLC_DegradeEffect, WsfEW_SLC_Effect, and WsfEW_TrackEffect.

References WsfEW_Effect::WsfEW_Effect(), and WsfEW_RadiusEffect().

◆ GetRadiusFactor() [1/2]

double WsfEW_RadiusEffect::GetRadiusFactor ( WsfStringId aSystemTypeId ) const

Referenced by ApplyMitigatedEffect(), ApplyUnmitigatedEffect(), WsfEW_CoverPulseEffect::UpdateEffects(), WsfEW_SimpleFT_Effect::UpdateEffects(), WsfEW_TrackEffect::UpdateEffects(), and ~WsfEW_RadiusEffect().

◆ GetRadiusFactor() [2/2]

double WsfEW_RadiusEffect::GetRadiusFactor	(	WsfStringId	aSystemTypeId,
		RadiusLimitType	aJRL_Type ) const

◆ GetRadiusLimitMask()

int WsfEW_RadiusEffect::GetRadiusLimitMask ( WsfStringId aSystemTypeId ) const

References WsfEW_RadiusEffect::RadiusData::GetRadiusLimitMask().

Referenced by ApplyMitigatedEffect(), ApplyUnmitigatedEffect(), UpdateEffects(), and ~WsfEW_RadiusEffect().

◆ Initialize()

bool WsfEW_RadiusEffect::Initialize ( WsfSimulation & aSimulation )

overridevirtual

Reimplemented from WsfEW_Effect.

Reimplemented in WsfEW_RepeaterEffect, WsfEW_RPJ_Effect, WsfEW_SimpleFT_Effect, WsfEW_SLB_Effect, WsfEW_SLC_DegradeEffect, WsfEW_SLC_Effect, and WsfEW_TrackEffect.

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

Referenced by WsfEW_RepeaterEffect::Initialize().

◆ NewEffectData()

EffectData * WsfEW_RadiusEffect::NewEffectData ( )

inlineoverrideprotectedvirtual

Reimplemented from WsfEW_Effect.

Reimplemented in WsfEW_RepeaterEffect, WsfEW_RPJ_Effect, WsfEW_SimpleFT_Effect, WsfEW_SLC_DegradeEffect, and WsfEW_TrackEffect.

◆ operator=()

WsfEW_RadiusEffect & WsfEW_RadiusEffect::operator= ( const WsfEW_RadiusEffect & )

delete

References WsfEW_RadiusEffect().

◆ ProcessInput()

bool WsfEW_RadiusEffect::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_Effect.

Reimplemented in WsfEW_RepeaterEffect, WsfEW_RPJ_Effect, WsfEW_SimpleFT_Effect, WsfEW_SLB_Effect, WsfEW_SLC_DegradeEffect, WsfEW_SLC_Effect, and WsfEW_TrackEffect.

References WsfEW_Effect::ProcessInput().

Referenced by WsfEW_RepeaterEffect::ProcessInput().

◆ PropagateEffectDataPtr()

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

overrideprotectedvirtual

Propagate the new effect data pointer to the other classes for local casting.

Note: Assumes that the base effect data map has the correct pointer

Parameters

aSystemTypeId The system type id to propagate the pointer for.

Reimplemented from WsfEW_Effect.

Reimplemented in WsfEW_RepeaterEffect, WsfEW_RPJ_Effect, WsfEW_SimpleFT_Effect, WsfEW_SLC_DegradeEffect, and WsfEW_TrackEffect.

References WsfEW_Effect::PropagateEffectDataPtr().

Referenced by WsfEW_RepeaterEffect::PropagateEffectDataPtr().

◆ UpdateEffects()

void WsfEW_RadiusEffect::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 )

overridevirtual

Allows the effect to update any parameters needed before running an apply effect method.

Parameters

aSimTime	[input] The current simulation time.
aTargetInteraction	[input] The target interaction for the detection attempt.
aJammerToTgtInteraction	[input] The jammer interaction for the jammer Xmtr to victim Rcvr.
aTgtToJammerInteraction	[input] Optional jammer interaction for the Victim Xmtr to jammer Rcvr. This will have no value if the jammer Rcvr doesn't exist.
aEW_Effects	[input] The current effect that is being updated.
aEW_EffectPtr	[input] The currently processing EW effect pointer to prevent recursion in EW effect processing loops.

Reimplemented from WsfEW_Effect.

Reimplemented in WsfEW_RepeaterEffect, WsfEW_RPJ_Effect, WsfEW_SimpleFT_Effect, WsfEW_SLB_Effect, WsfEW_SLC_Effect, and WsfEW_TrackEffect.

References WsfEM_Interaction::BeginOneWayInteraction(), cJRL_EQUAL, cJRL_INSIDE, cJRL_OUTSIDE, WsfEM_Interaction::ComputeUndefinedGeometry(), GetRadiusLimitMask(), WsfEM_Interaction::GetReceiver(), WsfEM_Interaction::GetTransmitter(), WsfEW_Effect::mDebug, WsfEW_Effect::mEffectedSystemId, WsfEM_Interaction::RelativeData::mRange, WsfEM_Interaction::mRcvrToTgt, WsfEM_Interaction::mRcvrToXmtr, WsfEW_Effect::UpdateEffects(), and WsfEW_Effect::WsfEW_Effect().

Referenced by WsfEW_RepeaterEffect::UpdateEffects().

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

Classes

Public Types

Public Member Functions

Effect Data methods.

Delta gain effect Accessor/Mutator methods.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ RadiusTypeToValueMap

Member Enumeration Documentation

◆ RadiusLimitType

Constructor & Destructor Documentation

◆ WsfEW_RadiusEffect() [1/2]

◆ ~WsfEW_RadiusEffect()

◆ WsfEW_RadiusEffect() [2/2]

Member Function Documentation

◆ ApplyMitigatedEffect()

◆ ApplyUnmitigatedEffect()

◆ Clone()

◆ GetRadiusFactor() [1/2]

◆ GetRadiusFactor() [2/2]

◆ GetRadiusLimitMask()

◆ Initialize()

◆ NewEffectData()

◆ operator=()

◆ ProcessInput()

◆ PropagateEffectDataPtr()

◆ UpdateEffects()