WSF
wsf::cyber::AttackParameterObject Class Reference

This class is a simple wrapper for an AUX data container. More...

#include <WsfCyberAttackParameters.hpp>

Inheritance diagram for wsf::cyber::AttackParameterObject:
Collaboration diagram for wsf::cyber::AttackParameterObject:

Public Member Functions

 AttackParameterObject ()=default
 AttackParameterObject (bool aScriptUsage)
 ~AttackParameterObject () override=default
virtual AttackParameterObjectClone () const
const char * GetScriptClassName () const override
template<class T>
void GetParameter (const std::string &aEffectName, T *&aParameter) const
Public Member Functions inherited from WsfAuxDataEnabled
 WsfAuxDataEnabled ()=default
 WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabledoperator= (const WsfAuxDataEnabled &aRhs)
 WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabledoperator= (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
WsfAttributeContainerGetAuxData ()
const WsfAttributeContainerGetAuxData () const noexcept
const WsfAttributeContainerGetAuxDataConst () const noexcept

Additional Inherited Members

Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)> AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)> AuxDataDestroyed

Detailed Description

This class is a simple wrapper for an AUX data container.

Constructor & Destructor Documentation

◆ AttackParameterObject() [1/2]

wsf::cyber::AttackParameterObject::AttackParameterObject ( )
default

Referenced by Clone().

◆ AttackParameterObject() [2/2]

wsf::cyber::AttackParameterObject::AttackParameterObject ( bool aScriptUsage)
inlineexplicit

◆ ~AttackParameterObject()

wsf::cyber::AttackParameterObject::~AttackParameterObject ( )
overridedefault

Member Function Documentation

◆ Clone()

virtual AttackParameterObject * wsf::cyber::AttackParameterObject::Clone ( ) const
inlinevirtual

◆ GetParameter()

template<class T>
void wsf::cyber::AttackParameterObject::GetParameter ( const std::string & aEffectName,
T *& aParameter ) const
inline

A wrapper for the underlying AuxData.Get() method that provides a parameter associated with an effect name (or any string), and handles the provision of that data regardless if it was originated in the script context or otherwise.

References WsfAuxDataEnabled::GetAuxDataConst().

◆ GetScriptClassName()

const char * wsf::cyber::AttackParameterObject::GetScriptClassName ( ) const
inlineoverride

The documentation for this class was generated from the following file:
Copyrights Multiple, All Rights Reserved