WsfTrackProcessor_PurgeTracksEvent Class Reference

A nested class for the event that performs periodic purging of inactive tracks. More...

#include <WsfTrackProcessor.hpp>

Inheritance diagram for WsfTrackProcessor_PurgeTracksEvent:

Collaboration diagram for WsfTrackProcessor_PurgeTracksEvent:

Public Member Functions
	WsfTrackProcessor_PurgeTracksEvent ()=default
	WsfTrackProcessor_PurgeTracksEvent (double aSimTime, WsfTrackProcessor *aProcessorPtr, double aPurgeInterval)
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.

Protected Attributes
double	mPurgeInterval
WsfTrackProcessor *	mProcessorPtr
size_t	mPlatformIndex

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

Detailed Description

A nested class for the event that performs periodic purging of inactive tracks.

Constructor & Destructor Documentation

WsfTrackProcessor_PurgeTracksEvent() [1/2]

WsfTrackProcessor_PurgeTracksEvent::WsfTrackProcessor_PurgeTracksEvent ( )

default

Referenced by WsfTrackProcessor_PurgeTrackHistoryEvent::WsfTrackProcessor_PurgeTrackHistoryEvent().

WsfTrackProcessor_PurgeTracksEvent() [2/2]

WsfTrackProcessor_PurgeTracksEvent::WsfTrackProcessor_PurgeTracksEvent	(	double	aSimTime,
		WsfTrackProcessor *	aProcessorPtr,
		double	aPurgeInterval )

References mPlatformIndex, mProcessorPtr, mPurgeInterval, WsfEvent::SetTime(), and WsfEvent::WsfEvent().

Member Function Documentation

Execute()

WsfEvent::EventDisposition WsfTrackProcessor_PurgeTracksEvent::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, WsfEvent::cRESCHEDULE, WsfEvent::GetSimulation(), WsfEvent::GetTime(), mPlatformIndex, mProcessorPtr, mPurgeInterval, and WsfEvent::SetTime().

Member Data Documentation

mPlatformIndex

size_t WsfTrackProcessor_PurgeTracksEvent::mPlatformIndex

protected

Referenced by WsfTrackProcessor_PurgeTrackHistoryEvent::Execute(), Execute(), and WsfTrackProcessor_PurgeTracksEvent().

mProcessorPtr

WsfTrackProcessor* WsfTrackProcessor_PurgeTracksEvent::mProcessorPtr

protected

Referenced by WsfTrackProcessor_PurgeTrackHistoryEvent::Execute(), Execute(), and WsfTrackProcessor_PurgeTracksEvent().

mPurgeInterval

double WsfTrackProcessor_PurgeTracksEvent::mPurgeInterval

protected

Referenced by WsfTrackProcessor_PurgeTrackHistoryEvent::Execute(), Execute(), and WsfTrackProcessor_PurgeTracksEvent().

---

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

• WsfTrackProcessor.hpp
• WsfTrackProcessor.cpp