wsf::cyber::EngagementManager::EngagementData Class Reference

#include <WsfCyberEngagementManager.hpp>

Collaboration diagram for wsf::cyber::EngagementManager::EngagementData:

Public Member Functions
	EngagementData (Engagement aEngagement)
	EngagementData requires an engagement. Engagements can be moved, but not copied.
	~EngagementData ()=default
	EngagementData (const EngagementData &aSrc)=delete
	EngagementData (EngagementData &&aSrc)=default
Effect *	GetEffect (const std::string &aEffectName) const
Engagement &	GetEngagement ()
const AttackParameters &	GetParameters () const
bool	IsParametersValid () const
Effect &	AddEffect (const std::string &aEffectName)
void	RemoveEffect (const std::string &aEffectName)
void	RemoveEffects ()
void	AddParameters (const AttackParameters &aParameters)
void	RemoveParameters ()

Protected Attributes
Engagement	mEngagement
std::list< UtCloneablePtr< Effect > >	mEngagementEffects {}
AttackParameters	mParameters {}
bool	mParametersValid {false}

Detailed Description

A unified class container for holding all data associated with a particular engagement used by the manager.

Constructor & Destructor Documentation

EngagementData() [1/3]

wsf::cyber::EngagementManager::EngagementData::EngagementData ( Engagement aEngagement )

inline

EngagementData requires an engagement. Engagements can be moved, but not copied.

References mEngagement.

Referenced by EngagementData(), and EngagementData().

~EngagementData()

wsf::cyber::EngagementManager::EngagementData::~EngagementData ( )

default

EngagementData() [2/3]

wsf::cyber::EngagementManager::EngagementData::EngagementData ( const EngagementData & aSrc )

delete

No copying of data. Move semantics is allowed. We prevent copy constructor usage due to WsfScriptContext using a semantically incorrect implementation - copies require initialization calls that we don't want to do over again.

References EngagementData().

EngagementData() [3/3]

wsf::cyber::EngagementManager::EngagementData::EngagementData ( EngagementData && aSrc )

default

References EngagementData(), and GetEffect().

Member Function Documentation

AddEffect()

Effect & wsf::cyber::EngagementManager::EngagementData::AddEffect

(

const std::string &

aEffectName

)

References wsf::cyber::ScenarioExtension::Get(), mEngagement, mEngagementEffects, mParameters, and mParametersValid.

Referenced by wsf::cyber::EngagementManager::CyberAttackEffect().

AddParameters()

void wsf::cyber::EngagementManager::EngagementData::AddParameters

(

const AttackParameters &

aParameters

)

References mParameters, and mParametersValid.

GetEffect()

Effect * wsf::cyber::EngagementManager::EngagementData::GetEffect

(

const std::string &

aEffectName

)

const

References mEngagementEffects.

Referenced by wsf::cyber::EngagementManager::CyberAttackRecoveryDelay(), and EngagementData().

GetEngagement()

Engagement & wsf::cyber::EngagementManager::EngagementData::GetEngagement ( )

inline

References mEngagement.

Referenced by wsf::cyber::EngagementManager::CyberAttack(), wsf::cyber::EngagementManager::CyberAttackDetectionDelay(), wsf::cyber::EngagementManager::CyberAttackEffect(), wsf::cyber::EngagementManager::CyberAttackInitialize(), wsf::cyber::EngagementManager::CyberAttackRecoveryDelay(), wsf::cyber::EngagementManager::CyberScan(), and wsf::cyber::EngagementManager::CyberScanInitialize().

GetParameters()

const AttackParameters & wsf::cyber::EngagementManager::EngagementData::GetParameters ( ) const

inline

References mParameters.

IsParametersValid()

bool wsf::cyber::EngagementManager::EngagementData::IsParametersValid ( ) const

inline

References mParametersValid.

RemoveEffect()

void wsf::cyber::EngagementManager::EngagementData::RemoveEffect

(

const std::string &

aEffectName

)

References mEngagementEffects.

RemoveEffects()

void wsf::cyber::EngagementManager::EngagementData::RemoveEffects

(

)

References mEngagementEffects, and RemoveParameters().

Referenced by wsf::cyber::EngagementManager::CyberAttack(), and wsf::cyber::EngagementManager::CyberAttackRecoveryDelay().

RemoveParameters()

void wsf::cyber::EngagementManager::EngagementData::RemoveParameters

(

)

References mParametersValid.

Referenced by RemoveEffects().

Member Data Documentation

mEngagement

Engagement wsf::cyber::EngagementManager::EngagementData::mEngagement

protected

Referenced by AddEffect(), EngagementData(), and GetEngagement().

mEngagementEffects

std::list<UtCloneablePtr<Effect> > wsf::cyber::EngagementManager::EngagementData::mEngagementEffects {}

protected

Do not modify this to use another container type. std::list is used to avoid copies on insertion and removal.

Referenced by AddEffect(), GetEffect(), RemoveEffect(), and RemoveEffects().

mParameters

AttackParameters wsf::cyber::EngagementManager::EngagementData::mParameters {}

protected

Referenced by AddEffect(), AddParameters(), and GetParameters().

mParametersValid

bool wsf::cyber::EngagementManager::EngagementData::mParametersValid {false}

protected

Referenced by AddEffect(), AddParameters(), IsParametersValid(), and RemoveParameters().

---

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

• WsfCyberEngagementManager.hpp
• WsfCyberEngagementManager.cpp