WsfExtDetonation Class Reference

Assists external interfaces with processing incoming detonations. More...

#include <WsfExtDetonation.hpp>

Classes
struct	Result
	Contains the result of a detonation. More...

Public Types
enum	DetonationResult {   cOTHER = 0 , cENTITY_IMPACT = 1 , cENTITY_PROXIMATE_DETONATION = 2 , cGROUND_IMPACT = 3 ,   cGROUND_PROXIMATE_DETONATION = 4 , cDETONATION = 5 , cNONE = 6 , cHE_HIT_SMALL = 7 ,   cHE_HIT_MEDIUM = 8 , cHE_HIT_LARGE = 9 , cARMOR_PIERCING_HIT = 10 , cDIRT_BLAST_SMALL = 11 ,   cDIRT_BLAST_MEDIUM = 12 , cDIRT_BLAST_LARGE = 13 , cWATER_BLAST_SMALL = 14 , cWATER_BLAST_MEDIUM = 15 ,   cWATER_BLAST_LARGE = 16 , cAIR_HIT = 17 , cBUILDING_HIT_SMALL = 18 , cBUILDING_HIT_MEDIUM = 19 ,   cBUILDING_HIT_LARGE = 20 , cMINE_CLEARING_LINE_CHARGE = 21 , cENVIRONMENT_OBJECT_IMPACT = 22 , cENVIRONMENT_OBJECT_PROXIMATE_DETONATION = 23 ,   cWATER_IMPACT = 24 , cAIRBURST = 25 , cKILL_WITH_FRAGMENT_TYPE_1 = 26 , cKILL_WITH_FRAGMENT_TYPE_2 = 27 ,   cKILL_WITH_FRAGMENT_TYPE_3 = 28 , cKILL_WITH_FRAGMENT_TYPE_1_AFTER_FLYOUT_FAILURE = 29 , cKILL_WITH_FRAGMENT_TYPE_2_AFTER_FLYOUT_FAILURE = 30 , cMISS_DUE_TO_FLYOUT_FAILURE = 31 ,   cMISS_DUE_TO_ENDGAME_FAILURE = 32 , cMISS_DUE_TO_FLYOUT_AND_ENDGAME_FAILURE = 33 , cRESULT_CODE_COUNT }
	Detonation result codes from IEEE 1278 SISO-REF-010 (aka 'The DIS Enumerations Document'). More...

Public Member Functions
	WsfExtDetonation (WsfExtInterface *aInterfacePtr)
void	SetFiringEntity (WsfPlatform *aPlatformPtr)
	Set firing platform pointer.
void	SetTargetEntity (WsfPlatform *aPlatformPtr)
	Set target platform pointer.
void	SetWeaponEntity (WsfPlatform *aPlatformPtr)
	Set the weapon platform pointer.
void	SetWeaponEntityType (WsfStringId aWeaponTypeId)
	Set the weapon platform type (used for implicit weapons).
void	SetResult (unsigned int aResult)
	Set the expected result given by the external interface.
std::string	GetResultName () const
bool	DebugEnabled ()
void	SetDetonateLocation (double aDetonateLocationWCS[3])
	Sets the detonation location. This is used to search for a target if the target entity is not set.
void	SetRelativeDetonationLocation (double aDetonationLocationECS[3])
void	Execute (double aSimTime, Result &aResult)
	Execute the detonation, destroying the target if successful.
std::string	GetDefaultWeaponEffectName ()
WsfWeaponEffects *	GetDefaultWeaponEffect ()
WsfSimulation *	GetSimulation () const

Detailed Description

Assists external interfaces with processing incoming detonations.

Member Enumeration Documentation

DetonationResult

enum WsfExtDetonation::DetonationResult

Detonation result codes from IEEE 1278 SISO-REF-010 (aka 'The DIS Enumerations Document').

Enumerator
cOTHER
cENTITY_IMPACT
cENTITY_PROXIMATE_DETONATION
cGROUND_IMPACT
cGROUND_PROXIMATE_DETONATION
cDETONATION
cNONE
cHE_HIT_SMALL
cHE_HIT_MEDIUM
cHE_HIT_LARGE
cARMOR_PIERCING_HIT
cDIRT_BLAST_SMALL
cDIRT_BLAST_MEDIUM
cDIRT_BLAST_LARGE
cWATER_BLAST_SMALL
cWATER_BLAST_MEDIUM
cWATER_BLAST_LARGE
cAIR_HIT
cBUILDING_HIT_SMALL
cBUILDING_HIT_MEDIUM
cBUILDING_HIT_LARGE
cMINE_CLEARING_LINE_CHARGE
cENVIRONMENT_OBJECT_IMPACT
cENVIRONMENT_OBJECT_PROXIMATE_DETONATION
cWATER_IMPACT
cAIRBURST
cKILL_WITH_FRAGMENT_TYPE_1
cKILL_WITH_FRAGMENT_TYPE_2
cKILL_WITH_FRAGMENT_TYPE_3
cKILL_WITH_FRAGMENT_TYPE_1_AFTER_FLYOUT_FAILURE
cKILL_WITH_FRAGMENT_TYPE_2_AFTER_FLYOUT_FAILURE
cMISS_DUE_TO_FLYOUT_FAILURE
cMISS_DUE_TO_ENDGAME_FAILURE
cMISS_DUE_TO_FLYOUT_AND_ENDGAME_FAILURE
cRESULT_CODE_COUNT

Constructor & Destructor Documentation

WsfExtDetonation()

WsfExtDetonation::WsfExtDetonation

(

WsfExtInterface *

aInterfacePtr

)

References cENTITY_IMPACT, and WsfMilExtInterface::Find().

Member Function Documentation

DebugEnabled()

bool WsfExtDetonation::DebugEnabled

(

)

Referenced by Execute().

Execute()

void WsfExtDetonation::Execute	(	double	aSimTime,
		Result &	aResult )

Execute the detonation, destroying the target if successful.

References WsfWeaponEngagement::Assign(), WsfWeaponEngagement::cDUD, cRESULT_CODE_COUNT, WsfWeaponEngagement::cTARGET_IMPACT, DebugEnabled(), WsfWeaponEngagement::Delete(), WsfWeaponEngagement::Find(), WsfPlatform::GetIndex(), WsfWeaponEngagement::GetTargetPlatformIndex(), WsfWeaponEngagement::Initialize(), WsfUtil::MakeTrack(), WsfExtDetonation::Result::mDetonateLocationWCS, WsfExtDetonation::Result::mGeometryResult, WsfExtDetonation::Result::mIgnored, WsfExtDetonation::Result::mMissDistance, WsfExtDetonation::Result::mTargetLocationWCS, WsfExtDetonation::Result::mTargetPlatformPtr, WsfWeaponEngagement::SetFiringPlatform(), WsfWeaponEngagement::SetIsExternallyControlled(), WsfWeaponEngagement::SetTargetLocationWCS(), WsfWeaponEngagement::SetWeaponEffects(), WsfWeaponEngagement::SetWeaponLocationWCS(), targetIndex(), and WsfWeaponEngagement::Terminate().

Referenced by WsfDisDetonation::Process().

GetDefaultWeaponEffect()

WsfWeaponEffects * WsfExtDetonation::GetDefaultWeaponEffect

(

)

References GetSimulation().

GetDefaultWeaponEffectName()

std::string WsfExtDetonation::GetDefaultWeaponEffectName

(

)

GetResultName()

std::string WsfExtDetonation::GetResultName

(

)

const

References cRESULT_CODE_COUNT.

GetSimulation()

WsfSimulation * WsfExtDetonation::GetSimulation

(

)

const

Referenced by GetDefaultWeaponEffect().

SetDetonateLocation()

void WsfExtDetonation::SetDetonateLocation ( double aDetonateLocationWCS[3] )

inline

Sets the detonation location. This is used to search for a target if the target entity is not set.

Referenced by WsfDisDetonation::Process().

SetFiringEntity()

void WsfExtDetonation::SetFiringEntity ( WsfPlatform * aPlatformPtr )

inline

Set firing platform pointer.

Referenced by WsfDisDetonation::Process().

SetRelativeDetonationLocation()

void WsfExtDetonation::SetRelativeDetonationLocation ( double aDetonationLocationECS[3] )

inline

Referenced by WsfDisDetonation::Process().

SetResult()

void WsfExtDetonation::SetResult ( unsigned int aResult )

inline

Set the expected result given by the external interface.

Referenced by WsfDisDetonation::Process().

SetTargetEntity()

void WsfExtDetonation::SetTargetEntity ( WsfPlatform * aPlatformPtr )

inline

Set target platform pointer.

Referenced by WsfDisDetonation::Process().

SetWeaponEntity()

void WsfExtDetonation::SetWeaponEntity

(

WsfPlatform *

aPlatformPtr

)

Set the weapon platform pointer.

References WsfObject::GetTypeId().

Referenced by WsfDisDetonation::Process().

SetWeaponEntityType()

void WsfExtDetonation::SetWeaponEntityType ( WsfStringId aWeaponTypeId )

inline

Set the weapon platform type (used for implicit weapons).

Referenced by WsfDisDetonation::Process().

---

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

• WsfExtDetonation.hpp
• WsfExtDetonation.cpp