WsfMilDisPlatform Class Reference

#include <WsfMilDisPlatform.hpp>

Inheritance diagram for WsfMilDisPlatform:

Collaboration diagram for WsfMilDisPlatform:

Classes
class	JammerData
	A class used to hold data needed by the interface that is related to a jammer. More...

Public Member Functions
	WsfMilDisPlatform (WsfDisPlatform *aPlatformPtr)
	~WsfMilDisPlatform () override
Public Member Functions inherited from WsfComponentT< WsfDisPlatform >
	WsfComponentT ()
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
virtual void	ComponentParentChanged (ParentType *aParentPtr)
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
virtual int	GetComponentInitializationOrder () const
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual bool	PreInitialize (double aSimTime)
virtual bool	Initialize (double aSimTime)
virtual bool	Initialize2 (double aSimTime)
virtual void	PreInput ()
virtual bool	ProcessInput (UtInput &aInput)

Static Public Member Functions
static WsfMilDisPlatform *	Find (const WsfDisPlatform &aPlatform)

Component infrastructure methods
WsfComponent *	CloneComponent () const override
WsfStringId	GetComponentName () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
void	SendingEmission (double aSimTime, DisEmission *aEmissionPtr, DisEventId &aPreviousNumber) override
void	AllocateEmissionSystems (DisUint8 &emitterId) override
void	TurnOffEmission (DisEmission *aEmissionPtr) override
DisSystem *	GetJammerSystem (WsfWeapon *aWeaponPtr)
	Given a WSF weapon, locate its corresponding DIS system.
JammerData *	GetJammerData (WsfWeapon *aWeaponPtr)
void	UpdateJammerSystem (double aSimTime, WsfWeapon *aWeaponPtr, DisSystem *aSystemPtr, size_t aTargetIndex)
void	WeaponTurnedOff (double aSimTime, WsfWeapon *aWeaponPtr)
void	WeaponTurnedOn (double aSimTime, WsfWeapon *aWeaponPtr)
void	JammingRequestCanceled (double aSimTime, WsfWeapon *aWeaponPtr, size_t aTargetIndex)
void	JammingRequestInitiated (double aSimTime, WsfWeapon *aWeaponPtr, size_t aTargetIndex)
void	JammingRequestUpdated (double aSimTime, WsfWeapon *aWeaponPtr, size_t aTargetIndex)

Additional Inherited Members
Public Types inherited from WsfComponentT< WsfDisPlatform >
typedef WsfDisPlatform	ParentType
	This is needed to support the WsfComponentList template.

Constructor & Destructor Documentation

WsfMilDisPlatform()

WsfMilDisPlatform::WsfMilDisPlatform

(

WsfDisPlatform *

aPlatformPtr

)

References WsfMilDisInterface::Find(), and WsfDisPlatform::GetInterface().

Referenced by Find().

~WsfMilDisPlatform()

WsfMilDisPlatform::~WsfMilDisPlatform ( )

override

Member Function Documentation

AllocateEmissionSystems()

void WsfMilDisPlatform::AllocateEmissionSystems ( DisUint8 & emitterId )

overridevirtual

Reimplemented from WsfDisPlatformComponent.

References WsfComponentList::RoleIterator< T >::AtEnd().

CloneComponent()

WsfComponent * WsfMilDisPlatform::CloneComponent ( ) const

overridevirtual

Clones a component. May return null if component does not support clone.

Implements WsfComponent.

Find()

WsfMilDisPlatform * WsfMilDisPlatform::Find ( const WsfDisPlatform & aPlatform )

static

References WsfComponentList::FindByRole(), WsfDisPlatform::GetComponents(), and WsfMilDisPlatform().

GetComponentName()

WsfStringId WsfMilDisPlatform::GetComponentName ( ) const

overridevirtual

Returns the component's name. Each component in a component list has a unique name. Names are usually defined by the user, but they may also be generated by code and prefixed with a '#' to guarantee no collisions with user-defined names.

Implements WsfComponent.

GetComponentRoles()

const int * WsfMilDisPlatform::GetComponentRoles ( ) const

overridevirtual

Returns a zero-terminated array of component roles. Note that the array should be in decreasing order of specificity and should generally the inheritance hierarchy. The first entry should be the components 'primary' role. For example a sensor would do the following:

static const int roles[] = { cWSF_COMPONENT_SENSOR, cWSF_COMPONENT_ARTICULATED_PART,
                             cWSF_COMPONENT_PLATFORM_PART, 0 };
return roles;

Implements WsfComponent.

References cWSF_COMPONENT_MIL_DIS_PLATFORM.

GetJammerData()

WsfMilDisPlatform::JammerData * WsfMilDisPlatform::GetJammerData

(

WsfWeapon *

aWeaponPtr

)

Given a pointer to a WSF weapon, return a pointer to our jammer data.

Note

The return value may be zero.

Referenced by GetJammerSystem(), JammingRequestCanceled(), JammingRequestInitiated(), JammingRequestUpdated(), WeaponTurnedOff(), and WeaponTurnedOn().

GetJammerSystem()

DisSystem * WsfMilDisPlatform::GetJammerSystem

(

WsfWeapon *

aWeaponPtr

)

Given a WSF weapon, locate its corresponding DIS system.

References GetJammerData(), and WsfMilDisPlatform::JammerData::mSystemPtr.

JammingRequestCanceled()

void WsfMilDisPlatform::JammingRequestCanceled	(	double	aSimTime,
		WsfWeapon *	aWeaponPtr,
		size_t	aTargetIndex )

References GetJammerData(), WsfMilDisPlatform::JammerData::mSystemPtr, and UpdateJammerSystem().

JammingRequestInitiated()

void WsfMilDisPlatform::JammingRequestInitiated	(	double	aSimTime,
		WsfWeapon *	aWeaponPtr,
		size_t	aTargetIndex )

References GetJammerData(), WsfMilDisPlatform::JammerData::mSystemPtr, and UpdateJammerSystem().

JammingRequestUpdated()

void WsfMilDisPlatform::JammingRequestUpdated	(	double	aSimTime,
		WsfWeapon *	aWeaponPtr,
		size_t	aTargetIndex )

References GetJammerData(), WsfMilDisPlatform::JammerData::mSystemPtr, and UpdateJammerSystem().

QueryInterface()

void * WsfMilDisPlatform::QueryInterface ( int aRole )

overridevirtual

Requests a component's role interface. A component can support one or more roles.

Parameters

aRole

The role whose interface is to be returned.

Returns

A pointer to the object if it supports the indicated role, or 'null' if it does not. Usage: WsfProcessor* procPtrOrNull = (WsfProcessor*)componentPtr->QueryComponentInterface(cWSF_COMPONENT_PROCESSOR);

Implements WsfComponent.

References cWSF_COMPONENT_MIL_DIS_PLATFORM.

SendingEmission()

void WsfMilDisPlatform::SendingEmission ( double aSimTime, DisEmission * aEmissionPtr, DisEventId & aPreviousNumber )

overridevirtual

Reimplemented from WsfDisPlatformComponent.

References WsfMilDisInterface::Find(), WsfDisInterface::ImmediatePutPdu(), WsfMilDisPlatform::JammerData::mLastBeamCountSent, WsfMilDisPlatform::JammerData::mSystemPtr, and WsfMilDisInterface::UpdateSystemFromWeapon().

TurnOffEmission()

void WsfMilDisPlatform::TurnOffEmission ( DisEmission * aEmissionPtr )

overridevirtual

Reimplemented from WsfDisPlatformComponent.

UpdateJammerSystem()

void WsfMilDisPlatform::UpdateJammerSystem	(	double	aSimTime,
		WsfWeapon *	aWeaponPtr,
		DisSystem *	aSystemPtr,
		size_t	aTargetIndex )

References WsfWeapon::GetCurrentModeName(), WsfWeapon::GetEM_Xmtr(), WsfWeapon::GetEM_XmtrCount(), WsfDisInterface::GetEntityId(), WsfSimulation::GetPlatformByIndex(), WsfSimulationExtension::GetSimulation(), WsfWeapon::GetTargetIndex(), WsfUniqueId::GetUniqueId(), and WsfDisInterface::SetBeamTypeAndFunction().

Referenced by JammingRequestCanceled(), JammingRequestInitiated(), JammingRequestUpdated(), and WeaponTurnedOn().

WeaponTurnedOff()

void WsfMilDisPlatform::WeaponTurnedOff	(	double	aSimTime,
		WsfWeapon *	aWeaponPtr )

References GetJammerData(), and WsfMilDisPlatform::JammerData::mSystemPtr.

WeaponTurnedOn()

void WsfMilDisPlatform::WeaponTurnedOn	(	double	aSimTime,
		WsfWeapon *	aWeaponPtr )

References GetJammerData(), WsfMilDisPlatform::JammerData::mSystemPtr, and UpdateJammerSystem().

---

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

• WsfMilDisPlatform.hpp
• WsfMilDisPlatform.cpp