#include <WsfTimeDelayQueue.hpp>

Inheritance diagram for WsfTimeDelayQueue::Request:

[legend]

Public Member Functions
	Request (double aTimeRequired)
virtual	~Request ()=default
virtual bool	CompleteRequest (double aSimTime)=0
double	TimeRequired () const
	Get the amount of time needed to complete the request.
void	SetTimeRequired (double aTimeRequired)
	Set the amount of time needed to complete the request.

Detailed Description

An abstract base class that represents a request to be performed. The caller must derive from this class and provide an implementation for CompleteRequest() to perform the actual work.

Constructor & Destructor Documentation

◆ Request()

WsfTimeDelayQueue::Request::Request ( double aTimeRequired )

inline

Construct a request.

Parameters

aTimeRequired The time required to complete the request.

Referenced by WsfMessageProcessor::DelayRequest::DelayRequest(), and WsfTrackStateController_EvaluateRequest::WsfTrackStateController_EvaluateRequest().

◆ ~Request()

virtual WsfTimeDelayQueue::Request::~Request ( )

virtualdefault

Member Function Documentation

◆ CompleteRequest()

virtual bool WsfTimeDelayQueue::Request::CompleteRequest ( double aSimTime )

pure virtual

Perform the actual processing associated with the request.

Parameters

aSimTime The current simulation time.

Returns: If true then the request is complete. If false then the request is not complete and SetTimeRequired should have been called to set the ADDITIONAL time needed to complete the request.

Implemented in WsfMessageProcessor::DelayRequest, and WsfTrackStateController_EvaluateRequest.

Referenced by WsfTimeDelayQueue::CompleteRequest().