WsfWeaponTask Class Reference

A class that defines a task to be performed. More...

#include <WsfWeaponTask.hpp>

Inheritance diagram for WsfWeaponTask:

Collaboration diagram for WsfWeaponTask:

Public Member Functions
	WsfWeaponTask ()=default
	WsfWeaponTask (const WsfTaskResource &aTaskResource)
	WsfWeaponTask (const WsfTask &aSrc)
WsfWeaponTask &	operator= (const WsfTask &aRhs)
	~WsfWeaponTask () override=default
const char *	GetScriptClassName () const override
Public Member Functions inherited from WsfTask
	WsfTask ()
	WsfTask (const WsfTask &aSrc)
	WsfTask (const WsfTaskResource &aTaskResource)
WsfTask &	operator= (const WsfTask &aRhs)
	~WsfTask () override=default
bool	operator== (const WsfTask &aRhs) const
bool	operator!= (const WsfTask &aRhs) const
const char *	GetScriptClassName () const override
void	Initialize (double aSimTime, unsigned long aTaskId, WsfProcessor *aAssignerPtr)
unsigned int	GetTaskId () const
	Return the task ID assigned to the task.
const WsfTrackId &	GetTrackId () const
void	SetTrackId (const WsfTrackId &aTrackId)
const WsfTrackId &	GetLocalTrackId () const
void	SetLocalTrackId (const WsfTrackId &aLocalTrackId)
WsfStringId	GetTaskType () const
void	SetTaskType (WsfStringId aTaskType)
WsfStringId	GetTargetName () const
void	SetTargetName (WsfStringId aTargetName)
	Set the name of the target.
void	SetAssigner (const WsfTask &aTask)
WsfStringId	GetAssignerPlatformName () const
size_t	GetAssignerPlatformIndex () const
WsfStringId	GetAssignerProcessorName () const
void	SetAssignee (WsfPlatform *aAssigneePtr)
WsfStringId	GetAssigneePlatformName () const
size_t	GetAssigneePlatformIndex () const
WsfStringId	GetAssigneeProcessorName () const
void	SetAssigneeProcessorName (WsfStringId aAssigneeProcessorName)
WsfTaskResource &	GetResource ()
const WsfTaskResource &	GetResource () const
void	SetResource (const WsfTaskResource &aResource)
WsfStringId	GetResourceName () const
void	SetResourceName (WsfStringId aResourceName)
int	GetResourceType () const
bool	IsResourceTypeOf (const int aResourceType) const
WsfStringId	GetResourceMode () const
void	SetResourceMode (WsfStringId aResourceMode)
WsfStringId	GetCommName () const
void	SetCommName (WsfStringId aCommName)
void	SetUpdateTime (double aUpdateTime)
double	GetUpdateTime () const
void	SetAssignTime (double aAssignTime)
double	GetAssignTime () const
void	SetStatus (WsfStringId aStatusId)
WsfStringId	GetStatus () const
void	SetSubStatus (WsfStringId aSubStatusId)
WsfStringId	GetSubStatus () const
int	GetObjectsPending () const
	Return the number of objects that have been assigned but not yet in operation.
void	SetObjectsPending (int aObjectsPending)
	Set the number of objects that have been assigned but not yet in operation.
void	SetAssignerPlatformIndex (size_t aIndex)
void	SetAssigneePlatformIndex (size_t aIndex)
Public Member Functions inherited from WsfTaskData
	WsfTaskData ()
	WsfTaskData (const WsfTaskData &aSrc)
	WsfTaskData (const WsfTaskResource &aTaskResource)
WsfTaskData &	operator= (const WsfTaskData &aRhs)
virtual	~WsfTaskData ()
template<typename T>
void	SerializeP (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

Static Public Member Functions
static void	RegisterScriptTypes (UtScriptTypes *aScriptTypesPtr)
static void	RegisterScriptMethods (UtScriptTypes &aScriptTypes)
Static Public Member Functions inherited from WsfTask
static void	RegisterScriptTypes (UtScriptTypes *aScriptTypesPtr)

Additional Inherited Members
Public Attributes inherited from WsfTaskData
unsigned int	mTaskId
	The serial number of the task.
WsfTrackId	mTrackId
WsfTrackId	mLocalTrackId
WsfStringId	mTaskType
	The task type (string ID).
WsfStringId	mTargetName
	The name of the target (string ID) IF it is known.
WsfStringId	mAssignerPlatformName
	The name of the assigning platform (string ID).
size_t	mAssignerPlatformIndex
	The platform index of the assigning platform.
WsfStringId	mAssignerProcessorName
	The name of the processor on the assigning platform (string ID).
WsfStringId	mAssigneePlatformName
	The name of the assigned platform (string ID).
size_t	mAssigneePlatformIndex
	The platform index of the assigned platform.
WsfStringId	mAssigneeProcessorName
	The name of the processor on the assigned platform (string ID).
WsfTaskResource *	mResourcePtr
	Attributes of the assigned resource.
WsfStringId	mCommName
double	mAssignTime
	The simulation time when the assignment was made.
double	mUpdateTime
	The simulation time when an update was last sent or received.
int	mObjectsPending
	The number of objects that are pending (requested but not yet in operation).
WsfStringId	mTaskStatus
	Task status.
WsfStringId	mTaskSubStatus
	Task sub status reported by assignee. (User Defined).
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed

Detailed Description

A class that defines a task to be performed.

Constructor & Destructor Documentation

WsfWeaponTask() [1/3]

WsfWeaponTask::WsfWeaponTask ( )

default

Referenced by operator=().

WsfWeaponTask() [2/3]

WsfWeaponTask::WsfWeaponTask ( const WsfTaskResource & aTaskResource )

inline

References WsfTask::WsfTask().

WsfWeaponTask() [3/3]

WsfWeaponTask::WsfWeaponTask ( const WsfTask & aSrc )

inline

References WsfTask::WsfTask().

~WsfWeaponTask()

WsfWeaponTask::~WsfWeaponTask ( )

overridedefault

Member Function Documentation

GetScriptClassName()

const char * WsfWeaponTask::GetScriptClassName ( ) const

inlineoverride

operator=()

WsfWeaponTask & WsfWeaponTask::operator= ( const WsfTask & aRhs )

inline

References WsfTaskData::operator=(), WsfTask::WsfTask(), and WsfWeaponTask().

RegisterScriptMethods()

void WsfWeaponTask::RegisterScriptMethods ( UtScriptTypes & aScriptTypes )

static

Register the script methods associated with this class.

Note

The WsfPlatform script class must be defined before calling this method.

Referenced by WsfMilScriptExtensions::ExtendScriptClasses().

RegisterScriptTypes()

void WsfWeaponTask::RegisterScriptTypes ( UtScriptTypes * aScriptTypesPtr )

static

Register the types ('class' objects) for the scripting systems.

This is invoked once by WsfScriptManager to create the 'class' objects that are implemented by this file.

---

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

• WsfWeaponTask.hpp
• WsfWeaponTask.cpp