WsfMessageProcessor::DelayRequest Class Reference

A unit of work within a time delay queue. More...

#include <WsfMessageProcessor.hpp>

Inheritance diagram for WsfMessageProcessor::DelayRequest:

Collaboration diagram for WsfMessageProcessor::DelayRequest:

Public Member Functions
	DelayRequest (WsfMessageProcessor *aProcessorPtr, const WsfMessage &aMessage, Action *aActionPtr, double aDelayTime)
	~DelayRequest () override
bool	operator< (const DelayRequest &aRhs) const
bool	CompleteRequest (double aSimTime) override
Public Member Functions inherited from WsfTimeDelayQueue::Request
	Request (double aTimeRequired)
virtual	~Request ()=default
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.

Public Attributes
WsfMessageProcessor *	mProcessorPtr
WsfMessage *	mMessagePtr
Action *	mActionPtr
int	mPriority

Detailed Description

A unit of work within a time delay queue.

Constructor & Destructor Documentation

DelayRequest()

WsfMessageProcessor::DelayRequest::DelayRequest	(	WsfMessageProcessor *	aProcessorPtr,
		const WsfMessage &	aMessage,
		Action *	aActionPtr,
		double	aDelayTime )

References WsfMessageProcessor::Clone(), mActionPtr, mMessagePtr, mPriority, mProcessorPtr, WsfTimeDelayQueue::Request::Request(), and WsfMessageProcessor::WsfMessageProcessor().

Referenced by operator<().

~DelayRequest()

WsfMessageProcessor::DelayRequest::~DelayRequest ( )

override

References mMessagePtr.

Member Function Documentation

CompleteRequest()

bool WsfMessageProcessor::DelayRequest::CompleteRequest ( double aSimTime )

overridevirtual

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.

Implements WsfTimeDelayQueue::Request.

References mActionPtr, mMessagePtr, and mProcessorPtr.

operator<()

bool WsfMessageProcessor::DelayRequest::operator< ( const DelayRequest & aRhs ) const

inline

References DelayRequest(), and mPriority.

Member Data Documentation

mActionPtr

Action* WsfMessageProcessor::DelayRequest::mActionPtr

Referenced by CompleteRequest(), and DelayRequest().

mMessagePtr

WsfMessage* WsfMessageProcessor::DelayRequest::mMessagePtr

Referenced by CompleteRequest(), DelayRequest(), and ~DelayRequest().

mPriority

int WsfMessageProcessor::DelayRequest::mPriority

Referenced by DelayRequest(), and operator<().

mProcessorPtr

WsfMessageProcessor* WsfMessageProcessor::DelayRequest::mProcessorPtr

Referenced by CompleteRequest(), and DelayRequest().

---

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

• WsfMessageProcessor.hpp
• WsfMessageProcessor.cpp