WsfImplicitWeapon::TerminateEngagementEvent Class Reference

#include <WsfImplicitWeapon.hpp>

Inheritance diagram for WsfImplicitWeapon::TerminateEngagementEvent:

Collaboration diagram for WsfImplicitWeapon::TerminateEngagementEvent:

Public Member Functions
	TerminateEngagementEvent ()=default
	TerminateEngagementEvent (double aSimTime, size_t aWeaponPlatformIndex, WsfImplicitWeapon *aImplicitWeaponPtr, EngagementData *&aEngagementDataPtr)
EventDisposition	Execute () override
Public Member Functions inherited from WsfEvent
	WsfEvent ()=default
	WsfEvent (double aSimTime, int aPriority=0)
	WsfEvent (const WsfEvent &aSrc)=delete
	Copy constructor and copy assignment deleted to prevent copying.
WsfEvent &	operator= (const WsfEvent &aRhs)=delete
virtual	~WsfEvent ()=default
double	GetTime () const
int	GetPriority () const
bool	ShouldExecute () const
void	SetTime (double aSimTime)
void	SetPriority (int aPriority)
void	SetShouldExecute (bool aExecute)
WsfSimulation *	GetSimulation () const
void	AddedToEventQueue (WsfSimulation &aSimulation)
	Called when the event is added to the event queue of the specified simulation.

Additional Inherited Members
Public Types inherited from WsfEvent
enum	EventDisposition { cDELETE , cRESCHEDULE }

Constructor & Destructor Documentation

TerminateEngagementEvent() [1/2]

WsfImplicitWeapon::TerminateEngagementEvent::TerminateEngagementEvent ( )

default

References Execute(), TerminateEngagementEvent(), and WsfImplicitWeapon::WsfImplicitWeapon().

Referenced by TerminateEngagementEvent().

TerminateEngagementEvent() [2/2]

WsfImplicitWeapon::TerminateEngagementEvent::TerminateEngagementEvent	(	double	aSimTime,
		size_t	aWeaponPlatformIndex,
		WsfImplicitWeapon *	aImplicitWeaponPtr,
		EngagementData *&	aEngagementDataPtr )

References WsfImplicitWeapon::EngagementData::mTerminateSet, WsfEvent::WsfEvent(), and WsfImplicitWeapon::WsfImplicitWeapon().

Member Function Documentation

Execute()

WsfEvent::EventDisposition WsfImplicitWeapon::TerminateEngagementEvent::Execute ( )

overridevirtual

Execute the specified event.

Returns

The disposition of the event. This indicates to the event manager what should be done with the event. If cRESCHEDULE then Execute should have called SetTime to set the time for which the event manager should reschedule the event.

Implements WsfEvent.

References WsfEvent::cDELETE, WsfSimulation::GetPlatformByIndex(), WsfEvent::GetSimulation(), WsfEvent::GetTime(), WsfObserver::ImplicitWeaponEndEngagement(), WsfWeaponEngagement::IsComplete(), and WsfWeaponEngagement::Terminate().

Referenced by TerminateEngagementEvent().

---

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

• WsfImplicitWeapon.hpp
• WsfImplicitWeapon.cpp