#include <WsfTaskProcessor.hpp>

Inheritance diagram for WsfTaskProcessor:

[legend]

Collaboration diagram for WsfTaskProcessor:

[legend]

Public Member Functions
	WsfTaskProcessor (WsfScenario &aScenario, const std::string &aClassName="WsfTaskProcessor")
	WsfTaskProcessor (const WsfTaskProcessor &aSrc)
	~WsfTaskProcessor () override
const char *	GetScriptClassName () const override
Public Member Functions inherited from WsfTaskManager
	WsfTaskManager (WsfScenario &aScenario, const std::string &aClassName="WsfTaskManager")
	Constructor.
WsfTaskManager &	operator= (const WsfTaskManager &)=delete
	~WsfTaskManager () override=default
const char *	GetScriptClassName () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
bool	PreInitialize (double aSimTime) override
bool	ReceiveMessage (double aSimTime, const WsfMessage &aMessage) override
void	Update (double aSimTime) override
virtual bool	AssignTask (double aSimTime, const WsfTrack &aTrack, const WsfTask &aTask, bool aLockTrack=true)
virtual bool	AssignTask (double aSimTime, const WsfTrack &aTrack, WsfStringId aTaskType, const WsfTaskResource &aResource, WsfPlatform *aAssigneePtr, WsfStringId aCommName)
virtual bool	CancelTask (double aSimTime, unsigned int aTaskId)
virtual void	CancelTask (double aSimTime, WsfTask &aTask, bool aSendCancelMessage)
virtual bool	CancelTask (double aSimTime, const WsfTrackId &aTrackId, WsfStringId aTaskType, const WsfTaskResource &aResource, size_t aAssigneeIndex)
virtual bool	CreateDelayTask (double aSimTime, double aDelayTime, const WsfTrack &aTrack, WsfStringId aTaskType)
virtual bool	ChangeOperatingLevel (double aSimTime, WsfStringId aName, int aLevel, WsfPlatform *aAssigneePtr, WsfStringId aCommName)
	Change the operating level for a given subordinate.
virtual bool	ReportTaskComplete (double aSimTime, const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName, WsfStringId aSubStatus)
virtual bool	ReportTaskProgress (double aSimTime, const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName, WsfStringId aSubStatus)
void	AssigneesForTask (const WsfTrackId &aTrackId, WsfStringId aTaskType, std::vector< size_t > &aAssignees) const
size_t	AssigneeForTask (const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName) const
int	OperatingLevelFor (WsfStringId aConditionName) const
	Return the current operating level for the specified condition name or status.
int	TasksAssignedTo (size_t aAssigneeIndex, const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName) const
int	TasksAssignedFor (const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName) const
int	TasksReceivedFor (const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName) const
double	TimeTaskAssigned (const WsfTrackId &aTrackId, WsfStringId aTaskType, size_t aAssigneeIndex) const
	Return the simulation time when a task was assigned.
TaskList &	AssignedTaskList ()
	Return the list of tasks this TaskManager has assigned.
TaskList &	ReceivedTaskList ()
	Return the list of tasks this TaskManager has received.
double	TimeLastTaskAssigned () const
double	TimeLastTaskReceived () const
void	CheckMessageAcknowledged (double aSimTime, unsigned int aSerialNumber)
bool	SendTaskMessage (double aSimTime, const WsfMessage &aMessage, size_t aRecipientIndex, WsfStringId aCommName, bool aReliable)
double	SendTrackUpdate (double aSimTime, unsigned int aTaskId)
WsfStringId	SelectCommDevice (WsfPlatform *aAssigneePtr, WsfStringId aCommName)
const TrackList &	ActiveTrackList () const
	Return the list of tasks this TaskManager has active.
bool	ShowTaskMessages () const
Public Member Functions inherited from WsfScriptProcessor
	WsfScriptProcessor (const WsfScenario &aScenario)
	WsfScriptProcessor (const WsfScenario &aScenario, WsfStringId aPartClass, const std::string &aPartVarName)
	~WsfScriptProcessor () override
void	SendMessage (double aSimTime, const WsfMessage &aMessage) override
virtual void	ExecuteOnMessageCreate (double aSimTime, WsfMessage &aMessage)
virtual bool	ExecuteScript (double aSimTime, const std::string &aScriptName)
virtual bool	ExecuteScript (double aSimTime, WsfStringId aScriptName, UtScriptData &aScriptRetVal, const UtScriptDataList &aScriptArgs=UtScriptDataList())
void	ExecuteScriptAtTime (double aTime, WsfStringId aScriptName, const UtScriptDataList &aScriptArgs)
virtual void	SuppressMessage (bool aSuppressMessage)
WsfScriptMessageHandler *	GetMessageHandler ()
WsfScriptContext &	GetScriptContext ()
UtScriptContext *	GetScriptAccessibleContext () const override
void	SetPlatform (WsfPlatform *aPlatformPtr) override
const WsfBehaviorTree *	BehaviorTree () const
WsfAdvancedBehaviorTree *	AdvancedBehaviorTree () const
virtual const WsfScriptStateMachine *	GetStateMachine () const
wsf::ExternalLinks &	GetExternalLinks ()
std::string	State ()
std::string	StateAll ()
void	SetState (std::string &stateName)
void	SetStateAll (std::string &stateNameAll)
Public Member Functions inherited from WsfProcessor
	WsfProcessor (const WsfScenario &aScenario)
	~WsfProcessor () override=default
ComponentList &	GetComponents ()
const ComponentList &	GetComponents () const
virtual void	ProcessCallback (double aSimTime, const WsfCallback &aCallback)
WsfComponent *	CloneComponent () const override
int	GetComponentInitializationOrder () const override
const char *	GetScriptClassName () const override
void	PreInput () override
void	SetNonOperational (double aSimTime) override
void	SetOperational (double aSimTime) override
void	PartBroken (double aSimTime) override
double	GetUpdateInterval () const override
void	SetUpdateInterval (double aUpdateInterval) override
Public Member Functions inherited from WsfPlatformPart
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () override
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
unsigned int	GetDebugMask ()
bool	IsExternallyControlled () const
int	GetPartType () const
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
const WsfScenario &	GetScenario () const
WsfStringId	GetComponentName () const override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override
WsfPlatform *	GetPlatform () const
virtual void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
double	GetLastStatusChangeTime () const
void	SetLastStatusChangeTime (double aSimTime)
	Allows a system to set the time at which the device was initialized.
bool	CanBeMadeOperational () const
	Returns an indication that this system can be made operational.
bool	CanBeMadeNonOperational () const
	Returns an indication that this system can be made non-operational.
bool	CanBeTurnedOn () const
	Returns an indication that this system can be turned on.
bool	CanBeTurnedOff () const
	Returns an indication that this system can be turned off.
bool	IsTurnedOn () const
bool	InitiallyTurnedOn () const
	Is the system to be turned 'on' when added to the simulation?
void	SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
	Sets if the system is turned on when added to the simulation.
virtual void	Restore (double aSimTime)
bool	IsOperational () const
bool	SetOperational (double aSimTime, bool aMakeOperational)
double	GetDamageFactor () const
bool	SetDamageFactor (double aSimTime, double aDamageFactor)
bool	IsCritical () const
void	SetCritical (bool aValue)
virtual void	OnPlatformBrokenEvent (double aSimTime)
	Owning platform has issued a broken event.
bool	IsBroken () const
WsfInternalLinks &	GetInternalLinks ()
	Return the internal links for this part.
virtual bool	HasInternalLinks () const
	Does this platform part have a communication link to other platform parts?
virtual void	SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void	SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void	SendQueuedMessages (double aSimTime)
const WsfCategoryList &	GetCategories () const
	Get the categories to which this part belongs.
void	AddCategory (WsfStringId aCategoryId)
	Adds the provided category to the platform part's category list.
bool	IsCategoryMember (WsfStringId aCategoryId) const
const WsfGroupList &	GetGroups () const
	Get the groups to which this platform part belongs.
void	JoinGroup (WsfGroup *aGroupPtr)
	Join the given group.
void	LeaveGroup (WsfGroup *aGroupPtr)
	Leave the given group.
bool	IsGroupMember (WsfStringId aGroupId)
unsigned int	GetUpdateEventEpoch () const
void	IncrementUpdateEventEpoch ()
bool	UpdateEventActive () const
	Is an 'Update' event active?
void	SetUpdateEventActive (bool aUpdateEventActive)
	Indicate if the 'Update' event is active.
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
Public Member Functions inherited from WsfUniqueId
	WsfUniqueId ()
	Construtor initializes the unique identifier to 0.
	WsfUniqueId (const WsfUniqueId &)
	Copy constructor initializes the unique identifier to 0.
WsfUniqueId &	operator= (const WsfUniqueId &)
unsigned int	GetUniqueId () const
	Get the unique identifier assigned to this object.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Framework methods
std::unique_ptr< WsfTrackStateController >	mControllerPtr
WsfProcessor *	Clone () const override
	A virtual copy constructor.
bool	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
void	PlatformDeleted (WsfPlatform *aPlatformPtr) override
bool	ProcessInput (UtInput &aInput) override
bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage) override
void	TurnOff (double aSimTime) override
void	TurnOn (double aSimTime) override
WsfTrackStateController &	GetTrackStateController ()
	Get the reference to the 'track state controller' object.
void	SetExternallyControlled (double aSimTime, bool aIsExternallyControlled) override
void	TaskCompleted (double aSimTime, WsfTask &aTask) override

Additional Inherited Members
Public Types inherited from WsfTaskManager
enum	TrackUpdateStrategy { cDEFAULT , cBATCH }
using	RoleIterator = WsfComponentList::RoleIterator<WsfTaskManagerComponent>
	typedef to simplify iteration for calling WsfTaskManagerComponent methods.
using	TaskList = std::list<WsfTask>
using	PendingMessageList = std::list<PendingMessage>
using	TrackList = std::list<ActiveTrack>
using	TrackListIter = std::list<ActiveTrack>::iterator
using	SensorRequestList = std::list<SensorRequest>
using	ComponentList = WsfComponentListT<WsfProcessorComponent>
Public Types inherited from WsfPlatformPart
enum	{ cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using	InternalMessageQueue = std::queue<WsfMessage*>
using	RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart, WsfMessage>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.
static TaskList::iterator	FindTask (TaskList &aTaskList, size_t aAssigneeIndex, const WsfTrackId &aTrackId, WsfStringId aTaskType, WsfStringId aResourceName)
static TaskList::iterator	FindTask (TaskList &aTaskList, unsigned int aTaskId)
static TaskList::iterator	FindTask (TaskList &aTaskList, unsigned int aTaskId, size_t aAssigneeIndex)
UtCallbackListN< void(double, WsfTask &, const WsfTrack &)>	OnTaskAssigned
	Executes when an assigned task is accepted (by this processor).
UtCallbackListN< void(double, WsfTask &)>	OnTaskCanceled
	Executes when a task cancel message is processed.
UtCallbackListN< void(double, WsfTask &)>	OnTaskCompleted
	Executes when an task complete is received.
UtCallbackListN< void(double, WsfTask &, const WsfTrack &)>	OnTaskAssignSent
	Executes when a task assignment is sent.
UtCallbackListN< void(double, WsfTask &, WsfStringId)>	OnTaskCompleteSent
	Executes when a task complete is sent.
UtCallbackListN< void(double, WsfTask &)>	OnTaskCancelSent
	Executes when a task cancel is sent.
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
virtual bool	ProcessAssociationMessage (double aSimTime, const WsfAssociationMessage &aMessage)
virtual bool	ProcessTaskAssignMessage (double aSimTime, const WsfTaskAssignMessage &aMessage)
virtual bool	ProcessTaskCancelMessage (double aSimTime, const WsfTaskCancelMessage &aMessage)
virtual bool	ProcessTaskControlMessage (double aSimTime, const WsfTaskControlMessage &aMessage)
virtual bool	ProcessTaskStatusMessage (double aSimTime, const WsfTaskStatusMessage &aMessage)
virtual bool	ProcessTrackDropMessage (double aSimTime, const WsfTrackDropMessage &aMessage)
	any sensor tasks for the dropped track will be reported complete/successful
virtual bool	ProcessTrackMessage (double aSimTime, const WsfTrackMessage &aMessage)
	WsfTaskManager (const WsfTaskManager &aSrc)
	Copy constructor.
virtual bool	AcquireResource (double aSimTime, WsfTask &aTask, const WsfTrack &aTrack)
virtual bool	ReleaseResource (double aSimTime, WsfTask &aTask)
virtual void	TaskCanceled (double aSimTime, WsfTask &aTask)
virtual void	TaskAssignSent (double aSimTime, const WsfTrack &aTrack, WsfTask &aTask)
virtual void	TaskAssigned (double aSimTime, const WsfTrack &aTrack, WsfTask &aTask)
virtual void	TaskCorrelated (double aSimTime, WsfTask &aTask)
	Called when a task has been correlated with a local track.
virtual void	OperatingLevelChanged (double aSimTime, std::string aLevel)
virtual void	TrackDropped (double aSimTime, const WsfTrackId &aTrackId)
bool	DropFromPurgedTaskList (TaskList &aPurgedTaskList, size_t aAssignerIndex, unsigned int aTaskId)
bool	GetMessageSender (const WsfMessage &aMessage, size_t &aSenderIndex, WsfStringId &aRcvrCommName)
	Given a message, get the platform index of the sender and the local device on which the message was received.
void	MessageAcknowledged (unsigned int aSerialNumber)
Protected Member Functions inherited from WsfScriptProcessor
	WsfScriptProcessor (const WsfScriptProcessor &aSrc)
	WsfProcessor (const WsfProcessor &aSrc)
	Copy constructor (for Clone()).
WsfProcessor &	operator= (const WsfProcessor &aRhs)=delete
	WsfPlatformPart (const WsfPlatformPart &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void	AssignUniqueId (WsfSimulation *aSimulationPtr)
WsfTrackManager *	mTrackManagerPtr
	The track manager that owns the tracks.
std::unique_ptr< WsfTimeDelayQueue >	mThinkerPtr
	The pointer to the 'thinker'.
PendingMessageList	mPendingMessageList
TrackList	mActiveTrackList
SensorRequestList	mSensorRequestList
std::map< WsfStringId, int >	mOperatingLevels
std::set< WsfSensor * >	mSensorsTurnedOn
	The sensors that have been implicitly turned on.
WsfScenario *	mScenarioPtr
UtCallbackHolder	mCallbacks
TaskList	mXmtdTaskList
	Tasks I have sent to others.
TaskList	mPurgedXmtdTaskList
TaskList	mRcvdTaskList
	Tasks I have received from others.
TaskList	mPurgedRcvdTaskList
std::set< WsfTrackId >	mPendingRcvdTasks
	The set of assigned track ID's that are awaiting correlation with local track ID's.
WsfStringId	mTrackProcessorName
	The name of the track processor whose track manager is the source of tracks.
double	mTrackUpdateInterval
WsfRandomVariable	mTimeToRecognizeMessage
	The amount of time it takes to recognize a message.
double	mCommRetryInterval
	The amount of time between attempts to retry failed communications.
int	mCommRetryAttempts
	The number of attempts to retry failed communications.
unsigned int	mNextTaskId
	The next task ID to be assigned.
bool	mShowTaskMessages
	True if task related messages are to be displayed.
bool	mShowUncompletedTasks
	True if leak termination data is to be shown.
TrackUpdateStrategy	mTrackUpdateStrategy
	Determine how track updates are sent.
double	mTimeLastTaskAssigned
	The time a task was last sent.
double	mTimeLastTaskReceived
	The time a task was last received.
Protected Attributes inherited from WsfScriptProcessor
WsfScriptContext *	mContextPtr
	Pointer to the script context.
WsfScriptMessageHandler *	mMessageHandlerPtr
	Pointer to the 'on_message' handler.
UtScript *	mOnMessageCreateScriptPtr
	Pointer to the 'on_message_create' script.
UtScriptClass *	mMessageClassPtr
wsf::ExternalLinks	mExternalLinks
	The external recipients.
WsfBehaviorTree *	mBehaviorTreePtr
ut::CloneablePtr< WsfAdvancedBehaviorTree >	mAdvancedBehaviorTreePtr
std::unique_ptr< WsfScriptStateMachine >	mStateMachinePtr
int	mStateIndex
bool	mSuppressMessage

Detailed Description

A processor for assigning and responding to tasks associated with tracks.

The 'task processor' is a combination of the task manager and track state controller (along with all the attendant script stuff). It basically cycles through the track list, evaluates the tracks and makes assignments.

Constructor & Destructor Documentation

◆ WsfTaskProcessor() [1/2]

WsfTaskProcessor::WsfTaskProcessor	(	WsfScenario &	aScenario,
		const std::string &	aClassName = "WsfTaskProcessor" )

Constructor.

Parameters

aScenario	The scenario
aClassName	The name of the script class to be associated with the PROCESSOR script variable. The default value is "WsfTaskProcessor", but can be overridden by a derived class if it has provided additional script class methods (note that this class does not provide any additional methods, so it uses WsfTaskProcessor).

References WsfScriptProcessor::mContextPtr, mControllerPtr, and WsfTaskManager::WsfTaskManager().

Referenced by Clone(), and WsfTaskProcessor().

◆ WsfTaskProcessor() [2/2]

WsfTaskProcessor::WsfTaskProcessor ( const WsfTaskProcessor & aSrc )

References WsfScriptProcessor::mContextPtr, mControllerPtr, WsfTaskManager::WsfTaskManager(), and WsfTaskProcessor().

◆ ~WsfTaskProcessor()

WsfTaskProcessor::~WsfTaskProcessor ( )

override

Member Function Documentation

◆ Clone()

WsfProcessor * WsfTaskProcessor::Clone ( ) const

overridevirtual

A virtual copy constructor.

Reimplemented from WsfTaskManager.

References WsfProcessor::WsfProcessor(), and WsfTaskProcessor().

◆ GetScriptClassName()

const char * WsfTaskProcessor::GetScriptClassName ( ) const

override

◆ GetTrackStateController()

WsfTrackStateController & WsfTaskProcessor::GetTrackStateController ( )

inline

Get the reference to the 'track state controller' object.

References mControllerPtr.

◆ Initialize()

bool WsfTaskProcessor::Initialize ( double aSimTime )

overridevirtual

Perform phase 1 initialization of the part. This is invoked by WsfPlatform::Initialize() during phase 1 initialization of the platform. During phase 1 initialization, platform components must not assume the existence of ANY data that is the responsibility of another platform component. In particular, the platform location and initial tracks cannot be assumed to be valid.

Parameters

aSimTime The current simulation time.

Returns: 'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfTaskManager.

References WsfTaskManager::Initialize(), and ok.

◆ Initialize2()

bool WsfTaskProcessor::Initialize2 ( double aSimTime )

overridevirtual

Perform phase 2 initialization of the part. This is invoked by WsfPlatform::Initialize() during phase 2 initialization of the platform. During phase 2, platform components may assume that the platform location has been defined, initial tracks have been loaded and that all components have completed phase 1 initialization.

Parameters

aSimTime The current simulation time.

Returns: 'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfTaskManager.

References WsfTaskManager::Initialize2(), mControllerPtr, WsfTaskManager::mThinkerPtr, WsfTaskManager::mTrackManagerPtr, and ok.

◆ PlatformDeleted()

void WsfTaskProcessor::PlatformDeleted ( WsfPlatform * aPlatformPtr )

overridevirtual

Some other platform has been deleted from the simulation.

This is invoked (via WsfPlatform::PlatformDeleted) whenever another platform has been deleted from the simulation.

Parameters

aPlatformPtr Pointer to the platform being deleted.

Reimplemented from WsfTaskManager.

References WsfTaskManager::PlatformDeleted().

◆ ProcessInput()

bool WsfTaskProcessor::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfTaskManager.

References WsfPlatformPart::GetScenario(), mControllerPtr, and WsfTaskManager::ProcessInput().

◆ ProcessMessage()

bool WsfTaskProcessor::ProcessMessage	(	double	aSimTime,
		const WsfMessage &	aMessage )

overridevirtual

Process a received message.

Parameters

aSimTime	The current simulation time.
aMessage	The message that is being sent.

Returns: 'true' if the message was processed or 'false' if not.

Note: A message is first received by ReceiveMessage which then calls ProcessMessage to process the message. A derived class ReceiveMessage method may choose to delay the message before calling ProcessMessage or may choose to ignore the message altogether.

Reimplemented from WsfTaskManager.

References WsfPlatformPart::IsExternallyControlled(), mControllerPtr, WsfScriptProcessor::mMessageHandlerPtr, and WsfTaskManager::ProcessMessage().

◆ SetExternallyControlled()

void WsfTaskProcessor::SetExternallyControlled	(	double	aSimTime,
		bool	aIsExternallyControlled )

overridevirtual

Reimplemented from WsfPlatformPart.

References WsfPlatformPart::IsTurnedOn(), mControllerPtr, and WsfPlatformPart::SetExternallyControlled().

Referenced by WsfXIO_TaskService::HandleRequest().

◆ TaskCompleted()

void WsfTaskProcessor::TaskCompleted	(	double	aSimTime,
		WsfTask &	aTask )

overrideprotectedvirtual

Reimplemented from WsfTaskManager.

References WsfTask::GetLocalTrackId(), WsfPlatformPart::IsExternallyControlled(), mControllerPtr, and WsfTaskManager::TaskCompleted().

◆ TurnOff()

void WsfTaskProcessor::TurnOff ( double aSimTime )

overridevirtual

Turn the processor off. The processor will no longer be called for received messages or periodic updates until it is turned on again.

Parameters

aSimTime The current simulation time.

Note: This method should not be invoked directly by application code. Use the WsfSimulation::TurnProcessorOff method.

Reimplemented from WsfTaskManager.

References mControllerPtr, and WsfTaskManager::TurnOff().

◆ TurnOn()

void WsfTaskProcessor::TurnOn ( double aSimTime )

overridevirtual

Turn the processor on. The processor will now be called for received messages and periodic updates.

Parameters

aSimTime The current simulation time.

Note: This method should not be invoked directly by application code. Use the WsfSimulation::TurnProcessorOn method.

Reimplemented from WsfTaskManager.

References WsfPlatformPart::IsExternallyControlled(), mControllerPtr, and WsfTaskManager::TurnOn().

Member Data Documentation

◆ mControllerPtr

std::unique_ptr<WsfTrackStateController> WsfTaskProcessor::mControllerPtr

protected

Referenced by GetTrackStateController(), Initialize2(), ProcessInput(), ProcessMessage(), SetExternallyControlled(), TaskCompleted(), TurnOff(), TurnOn(), WsfTaskProcessor(), and WsfTaskProcessor().

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

Public Member Functions

Framework methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfTaskProcessor() [1/2]

◆ WsfTaskProcessor() [2/2]

◆ ~WsfTaskProcessor()

Member Function Documentation

◆ Clone()

◆ GetScriptClassName()

◆ GetTrackStateController()

◆ Initialize()

◆ Initialize2()

◆ PlatformDeleted()

◆ ProcessInput()

◆ ProcessMessage()

◆ SetExternallyControlled()

◆ TaskCompleted()

◆ TurnOff()

◆ TurnOn()

Member Data Documentation

◆ mControllerPtr