Special class to handle the EA specific technique implementations as required. More...

#include <WsfEW_EA.hpp>

Inheritance diagram for WsfEW_EA::EA_Technique:

[legend]

Collaboration diagram for WsfEW_EA::EA_Technique:

[legend]

Public Member Functions
	EA_Technique ()=default
WsfEW_Technique *	Clone () const override
bool	Initialize (WsfSimulation &aSimulation) override
bool	ProcessInput (UtInput &aInput) override
WsfStringId	GetMitigationClassId () const override
Public Member Functions inherited from WsfEW_Technique
	WsfEW_Technique ()
WsfEW_Technique &	operator= (const WsfEW_Technique &)=delete
	~WsfEW_Technique () override
bool	CanApplyTechnique (unsigned int aSystemFunctionMask) const
virtual std::vector< WsfEW_Types::TechniqueId > *	GetMitigatedTechniqueIds ()
	Returns a pointer to the mitigated techniques list for this technique.
virtual std::vector< WsfEW_Types::TechniqueId > *	GetMitigatedTechniqueClassIds ()
	Returns a pointer to the mitigated techniques list for this technique.
WsfEW_Technique *	Clone () const override
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)
WsfEW_EA_EP *	GetEA_EP_Ptr () const
WsfEW_EA *	GetEA_Ptr () const
WsfEW_EP *	GetEP_Ptr () const
void	SetDefaultOn (bool aDefaultOn)
bool	IsDefaultOn () const
	Get the default 'on' state.
virtual bool	IsExternallyControlled () const
void	SetDebug (bool aDebug)
bool	DebugEnabled () const
bool	AddEffect (WsfEW_Effect *aEffectPtr)
bool	EffectIsAvailable (WsfStringId aEffectNameId) const
unsigned int	GetEffectCount ()
WsfEW_Effect *	GetEffect (unsigned int aIndex) const
WsfEW_Effect *	GetEffect (WsfStringId aEffectNameId) const
const EffectPtrVec &	GetEffects () const
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
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)

Additional Inherited Members
Public Types inherited from WsfEW_Technique
using	EffectPtrVec = std::vector<WsfEW_Effect*>
	A vector type to hold list of effects.
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	WsfEW_Technique (const WsfEW_Technique &aSrc)
bool	FindEffectIndex (WsfStringId aEffectNameId, unsigned int &aIndex) const
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Detailed Description

Special class to handle the EA specific technique implementations as required.

Constructor & Destructor Documentation

◆ EA_Technique()

WsfEW_EA::EA_Technique::EA_Technique ( )

default

References Clone(), Initialize(), ProcessInput(), and WsfEW_Technique::WsfEW_Technique().

Referenced by Clone().

Member Function Documentation

◆ Clone()

WsfEW_Technique * WsfEW_EA::EA_Technique::Clone ( ) const

overridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

References EA_Technique(), and WsfEW_Technique::WsfEW_Technique().

Referenced by EA_Technique().

◆ GetMitigationClassId()

WsfStringId WsfEW_EA::EA_Technique::GetMitigationClassId ( ) const

inlineoverridevirtual

Returns the user input mitigation flag ID for this EA technique that can be used to select EP techniques for mitigation.

Reimplemented from WsfEW_Technique.

◆ Initialize()

bool WsfEW_EA::EA_Technique::Initialize ( WsfSimulation & aSimulation )

overridevirtual

Reimplemented from WsfEW_Technique.

References WsfEW_Technique::Initialize().

Referenced by EA_Technique(), and WsfEW_EA::SetDeltaGainTechnique().

◆ ProcessInput()

bool WsfEW_EA::EA_Technique::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 WsfObject.

References WsfEW_Technique::ProcessInput().

Referenced by EA_Technique().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EA_Technique()

Member Function Documentation

◆ Clone()

◆ GetMitigationClassId()

◆ Initialize()

◆ ProcessInput()