WsfAirTargetFuse Class Reference

A specialization of WsfWeaponFuse that sets defaults approapriate for efficient Air-Target use. More...

#include <WsfAirTargetFuse.hpp>

Inheritance diagram for WsfAirTargetFuse:

Collaboration diagram for WsfAirTargetFuse:

Public Member Functions
	WsfAirTargetFuse (WsfScenario &aScenario)
WsfProcessor *	Clone () const override
bool	ProcessInput (UtInput &aInput) override
Public Member Functions inherited from WsfWeaponFuse
	WsfWeaponFuse (WsfScenario &aScenario)
	Constructor.
	WsfWeaponFuse (const WsfWeaponFuse &aSrc)
	Copy constructor.
	~WsfWeaponFuse () override
WsfWeaponFuse &	operator= (const WsfWeaponFuse &)=delete
const char *	GetScriptClassName () const override
WsfProcessor *	Clone () const override
bool	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	Update (double aSimTime) override
void	Detonate (double aSimTime)
void	Arm (double aSimTime)
	If the fuse is currently safed, command transition to the armed state.
Reason	GetReason () const
	Access the reason why the fuse arrived at its current State.
double	GetMaximumTimeOfFlight () const
	Access the values used to determine detonation based on Time, Altitude, and Speed.
SpeedCriteria	GetSpeedCriteria () const
double	GetMinSpeedLimit () const
AltCriteria	GetMSL_Criteria () const
AltCriteria	GetAGL_Criteria () const
double	GetAGL_Limit () const
double	GetMSL_Limit () const
double	GetTimeOfFlightToArm () const
void	SetAirToGroundMode (bool aValue)
void	SetAGL_Criteria (AltCriteria aCriteria, double aAltAGL)
void	SetMSL_Criteria (AltCriteria aCriteria, double aAltMSL)
void	SetTargetName (WsfStringId aNameId)
void	SetUseCurrentTarget (bool aValue)
void	SetGrossProximityRange (double aRange)
void	SetHitProximityRange (double aRange)
void	SetGrossUpdateInterval (double aInterval)
void	SetFineUpdateInterval (double aInterval)
void	SetTOFToArm (double aTOF)
Public Member Functions inherited from WsfScriptProcessor
	WsfScriptProcessor (const WsfScenario &aScenario)
	WsfScriptProcessor (const WsfScenario &aScenario, WsfStringId aPartClass, const std::string &aPartVarName)
	~WsfScriptProcessor () override
bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage) override
void	SendMessage (double aSimTime, const WsfMessage &aMessage) override
virtual void	ExecuteOnMessageCreate (double aSimTime, WsfMessage &aMessage)
virtual bool	ExecuteScript (double aSimTime, const std::string &aScriptName)
virtual bool	ExecuteScript (double aSimTime, WsfStringId aScriptName, UtScriptData &aScriptRetVal, const UtScriptDataList &aScriptArgs=UtScriptDataList())
void	ExecuteScriptAtTime (double aTime, WsfStringId aScriptName, const UtScriptDataList &aScriptArgs)
virtual void	SuppressMessage (bool aSuppressMessage)
WsfScriptMessageHandler *	GetMessageHandler ()
WsfScriptContext &	GetScriptContext ()
UtScriptContext *	GetScriptAccessibleContext () const override
void	SetPlatform (WsfPlatform *aPlatformPtr) override
const WsfBehaviorTree *	BehaviorTree () const
WsfAdvancedBehaviorTree *	AdvancedBehaviorTree () const
virtual const WsfScriptStateMachine *	GetStateMachine () const
wsf::ExternalLinks &	GetExternalLinks ()
std::string	State ()
std::string	StateAll ()
void	SetState (std::string &stateName)
void	SetStateAll (std::string &stateNameAll)
Public Member Functions inherited from WsfProcessor
	WsfProcessor (const WsfScenario &aScenario)
	~WsfProcessor () override=default
ComponentList &	GetComponents ()
const ComponentList &	GetComponents () const
virtual void	ProcessCallback (double aSimTime, const WsfCallback &aCallback)
WsfComponent *	CloneComponent () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
int	GetComponentInitializationOrder () const override
const char *	GetScriptClassName () const override
bool	PreInitialize (double aSimTime) override
void	PreInput () override
void	TurnOff (double aSimTime) override
void	TurnOn (double aSimTime) override
void	SetNonOperational (double aSimTime) override
void	SetOperational (double aSimTime) override
void	PartBroken (double aSimTime) override
double	GetUpdateInterval () const override
void	SetUpdateInterval (double aUpdateInterval) override
Public Member Functions inherited from WsfPlatformPart
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () override
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
unsigned int	GetDebugMask ()
bool	IsExternallyControlled () const
virtual void	SetExternallyControlled (double aSimTime, bool aIsExternallyControlled)
int	GetPartType () const
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
const WsfScenario &	GetScenario () const
WsfStringId	GetComponentName () const override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override
WsfPlatform *	GetPlatform () const
virtual void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
virtual void	PlatformDeleted (WsfPlatform *aPlatformPtr)
double	GetLastStatusChangeTime () const
void	SetLastStatusChangeTime (double aSimTime)
	Allows a system to set the time at which the device was initialized.
bool	CanBeMadeOperational () const
	Returns an indication that this system can be made operational.
bool	CanBeMadeNonOperational () const
	Returns an indication that this system can be made non-operational.
bool	CanBeTurnedOn () const
	Returns an indication that this system can be turned on.
bool	CanBeTurnedOff () const
	Returns an indication that this system can be turned off.
bool	IsTurnedOn () const
bool	InitiallyTurnedOn () const
	Is the system to be turned 'on' when added to the simulation?
void	SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
	Sets if the system is turned on when added to the simulation.
virtual void	Restore (double aSimTime)
bool	IsOperational () const
bool	SetOperational (double aSimTime, bool aMakeOperational)
double	GetDamageFactor () const
bool	SetDamageFactor (double aSimTime, double aDamageFactor)
bool	IsCritical () const
void	SetCritical (bool aValue)
virtual void	OnPlatformBrokenEvent (double aSimTime)
	Owning platform has issued a broken event.
bool	IsBroken () const
WsfInternalLinks &	GetInternalLinks ()
	Return the internal links for this part.
virtual bool	HasInternalLinks () const
	Does this platform part have a communication link to other platform parts?
virtual bool	ReceiveMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void	SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void	SendQueuedMessages (double aSimTime)
const WsfCategoryList &	GetCategories () const
	Get the categories to which this part belongs.
void	AddCategory (WsfStringId aCategoryId)
	Adds the provided category to the platform part's category list.
bool	IsCategoryMember (WsfStringId aCategoryId) const
const WsfGroupList &	GetGroups () const
	Get the groups to which this platform part belongs.
void	JoinGroup (WsfGroup *aGroupPtr)
	Join the given group.
void	LeaveGroup (WsfGroup *aGroupPtr)
	Leave the given group.
bool	IsGroupMember (WsfStringId aGroupId)
unsigned int	GetUpdateEventEpoch () const
void	IncrementUpdateEventEpoch ()
bool	UpdateEventActive () const
	Is an 'Update' event active?
void	SetUpdateEventActive (bool aUpdateEventActive)
	Indicate if the 'Update' event is active.
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)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
Public Member Functions inherited from WsfUniqueId
	WsfUniqueId ()
	Construtor initializes the unique identifier to 0.
	WsfUniqueId (const WsfUniqueId &)
	Copy constructor initializes the unique identifier to 0.
WsfUniqueId &	operator= (const WsfUniqueId &)
unsigned int	GetUniqueId () const
	Get the unique identifier assigned to this object.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Additional Inherited Members
Public Types inherited from WsfWeaponFuse
enum	AltCriteria { cNO_LIMIT , cDETONATE_ABOVE , cDETONATE_BELOW }
	The AGL/MSL detonation criteria. More...
enum	SpeedCriteria { cSC_NONE , cSC_SPEED , cSC_MACH , cSC_MACH_DECAY }
	The Minimum Speed detonation criteria. More...
enum	Reason {   cNO_REASON , cPROXIMITY , cAGL_LIMIT , cMSL_LIMIT ,   cMIN_SPEED , cTOF_LIMIT , cCOAST_TIME_LIMIT , cCOMMAND }
	Reason for the final state of the fuse object. More...
enum	OnIntercept { cACTION_DETONATE , cACTION_HALT }
using	ComponentList = WsfComponentListT<WsfProcessorComponent>
Public Types inherited from WsfPlatformPart
enum	{ cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using	InternalMessageQueue = std::queue<WsfMessage*>
using	RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart*, WsfMessage*>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.
Static Public Member Functions inherited from WsfWeaponFuse
static std::unique_ptr< UtScriptClass >	CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
Protected Types inherited from WsfWeaponFuse
enum	TargetLossOption { cDETONATE , cCOAST , cCANCEL_PROXIMITY_CHECKS , cCONSIDER_ALL_PROXIMITY }
void	CheckForDetonation (double aSimTime)
virtual void	PrivateDetonate (double aSimTime)
void	PrintDetonationReason (double aSimTime)
bool	ProcessAltAGL (double aSimTime)
bool	ProcessAltMSL (double aSimTime)
void	ProcessMinSpeed (double aSimTime)
bool	ProcessProximity (double aSimTime)
bool	CheckAllTargets (double aSimTime)
	Check all platforms to see if a detonation should occur.
double	ComputeGrossProximityRange (const double aTgtVelWCS[3]) const
double	ComputeTimeToPCAorFuse (const double aTgtLocWCS[3], const double aTgtVelWCS[3]) const
void	SelectPCA_ForDetonation (double aSimTime, WsfPlatform *aTgtPtr, const double aTgtLocWCS[3], const double aTgtVelWCS[3], double aTimeToPCA, double aMissDistanceLimit)
void	ShowPCA_Results (double aSimTime, WsfPlatform *aTgtPtr, const double aTgtLocWCS[3], const double aTgtVelWCS[3], double aTimeToPCA) const
bool	UpdateTargetState (double aSimTime)
void	UpdateWeaponState (double aSimTime)
void	PermanentlyArrestMotion (double aSimTime)
Protected Member Functions inherited from WsfScriptProcessor
	WsfScriptProcessor (const WsfScriptProcessor &aSrc)
	WsfProcessor (const WsfProcessor &aSrc)
	Copy constructor (for Clone()).
WsfProcessor &	operator= (const WsfProcessor &aRhs)=delete
	WsfPlatformPart (const WsfPlatformPart &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void	AssignUniqueId (WsfSimulation *aSimulationPtr)
Protected Attributes inherited from WsfScriptProcessor
WsfScriptContext *	mContextPtr
	Pointer to the script context.
WsfScriptMessageHandler *	mMessageHandlerPtr
	Pointer to the 'on_message' handler.
UtScript *	mOnMessageCreateScriptPtr
	Pointer to the 'on_message_create' script.
UtScriptClass *	mMessageClassPtr
wsf::ExternalLinks	mExternalLinks
	The external recipients.
WsfBehaviorTree *	mBehaviorTreePtr
ut::CloneablePtr< WsfAdvancedBehaviorTree >	mAdvancedBehaviorTreePtr
std::unique_ptr< WsfScriptStateMachine >	mStateMachinePtr
int	mStateIndex
bool	mSuppressMessage

Detailed Description

A specialization of WsfWeaponFuse that sets defaults approapriate for efficient Air-Target use.

All functionality is in the base class, so see WsfWeaponFuse for details.

Constructor & Destructor Documentation

WsfAirTargetFuse()

WsfAirTargetFuse::WsfAirTargetFuse

(

WsfScenario &

aScenario

)

References WsfWeaponFuse::cDETONATE_BELOW, WsfWeaponFuse::SetAGL_Criteria(), WsfWeaponFuse::SetGrossProximityRange(), WsfWeaponFuse::SetGrossUpdateInterval(), WsfWeaponFuse::SetUseCurrentTarget(), and WsfWeaponFuse::WsfWeaponFuse().

Referenced by Clone().

Member Function Documentation

Clone()

WsfProcessor * WsfAirTargetFuse::Clone ( ) const

overridevirtual

Create a clone of this object.

Returns

A pointer to the new copy.

Implements WsfProcessor.

References WsfAirTargetFuse(), and WsfProcessor::WsfProcessor().

ProcessInput()

bool WsfAirTargetFuse::ProcessInput ( UtInput & aInput )

overridevirtual

Primary purpose for this virtual method override is to prevent use of internally incompatible commands.

Reimplemented from WsfObject.

References WsfWeaponFuse::ProcessInput().

---

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

• WsfAirTargetFuse.hpp
• WsfAirTargetFuse.cpp