The WSF scenario extension for cyber. More...

#include <WsfCyberScenarioExtension.hpp>

Inheritance diagram for wsf::cyber::ScenarioExtension:

[legend]

Collaboration diagram for wsf::cyber::ScenarioExtension:

[legend]

Public Member Functions
void	AddedToScenario () override
bool	ProcessInput (UtInput &aInput) override
void	SimulationCreated (WsfSimulation &aSimulation) override
AttackTypes &	GetAttackTypes () const
EffectTypes &	GetEffectTypes () const
ProtectTypes &	GetProtectTypes () const
ConstraintTypes &	GetConstraintTypes () const
TriggerTypes &	GetTriggerTypes () const
Public Member Functions inherited from WsfScenarioExtension
	WsfScenarioExtension ()
	~WsfScenarioExtension () override
WsfScenario &	GetScenario () const
WsfApplication &	GetApplication () const
virtual void	FileLoaded (const std::string &aFileName)
virtual bool	Complete ()
virtual bool	Complete2 ()
virtual bool	AlwaysCreate ()
Public Member Functions inherited from WsfExtension
virtual	~WsfExtension ()=default
const std::string &	GetExtensionName () const

Static Public Member Functions
static ScenarioExtension &	Get (const WsfScenario &aScenario)
	Return a reference to the cyber scenario extension.

GetAttackTypeInputRequirement
Given the name of the attack and the input requirement being tested, returns a boolean value if any of the effects associated with the attack have the specified input requirement.
AttackTypes *	mAttackTypesPtr
EffectTypes *	mEffectTypesPtr
ProtectTypes *	mProtectTypesPtr
ConstraintTypes *	mConstraintTypesPtr
TriggerTypes *	mTriggerTypesPtr
bool	mDrawEnabled {false}
bool	GetAttackTypeInputRequirement (const std::string &aNamedAttack, Effect::InputRequirement aRequirement) const
bool	IsDrawEnabled () const

Type Existence Queries
These methods return if a particular type exists without required knowledge of the types themselves (no needed header)
bool	GetAttackTypeExists (const std::string &aNamedAttack) const
bool	GetEffectTypeExists (const std::string &aNamedEffect) const
bool	GetProtectTypeExists (const std::string &aNamedProtection) const
bool	GetTriggerTypeExists (const std::string &aNamedTrigger) const
bool	GetConstraintTypesExists (const std::string &aNamedConstraint) const

Additional Inherited Members
Protected Member Functions inherited from WsfExtension
void	InitializeExtensionName (const std::string &aName)

Detailed Description

The WSF scenario extension for cyber.

Member Function Documentation

◆ AddedToScenario()

void wsf::cyber::ScenarioExtension::AddedToScenario ( )

overridevirtual

Called when the extension has been added to the scenario. This is typically used to register new component type objects and object factories, e.g.:

WsfScenario& scenario(GetScenario());
WsfMoverTypes::Get(scenario).AddCoreType("MY_MOVER", new MyMover(scenario));
WsfAntennaPatterTypes::Get(scenario).AddObjectFactor(MyAntennaPattern::ObjectFactory);

Script classes must NOT be registered here because they are global to the entire application. They should be registered in WsfApplication::AddedToApplication.

Note: GetScenario() and GetApplication() are now valid.

Reimplemented from WsfScenarioExtension.

References WsfScenario::AddTypeList(), WsfEventPipeExtension::Find(), WsfScenarioExtension::GetScenario(), mAttackTypesPtr, mConstraintTypesPtr, mEffectTypesPtr, mProtectTypesPtr, mTriggerTypesPtr, wsf::cyber::ConstraintTypes::RegisterComponentFactory(), wsf::cyber::Protect::RegisterComponentFactory(), and wsf::cyber::EventPipe::RegisterEvents().

◆ Get()

ScenarioExtension & wsf::cyber::ScenarioExtension::Get ( const WsfScenario & aScenario )

static

Return a reference to the cyber scenario extension.

References WsfScenario::FindExtension(), WsfScenarioExtension::WsfScenario, and WsfScenarioExtension::WsfScenarioExtension().

Referenced by wsf::cyber::SimulationExtension::AddedToSimulation(), wsf::cyber::EngagementManager::EngagementData::AddEffect(), wsf::cyber::EngagementManager::CyberAttack(), wsf::cyber::EngagementManager::CyberScan(), wsf::cyber::random::RandomManager::Draw(), wsf::cyber::AttackTypes::Get(), wsf::cyber::AttackTypes::Get(), wsf::cyber::ConstraintTypes::Get(), wsf::cyber::ConstraintTypes::Get(), wsf::cyber::EffectTypes::Get(), wsf::cyber::EffectTypes::Get(), wsf::cyber::ProtectTypes::Get(), wsf::cyber::ProtectTypes::Get(), wsf::cyber::SimulationExtension::Initialize(), wsf::cyber::Engagement::MakeConstraintReservations(), wsf::cyber::Engagement::MeetsAttackerConstraints(), wsf::cyber::PlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT(), wsf::cyber::PlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT(), wsf::cyber::SimulationScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT(), and wsf::cyber::SimulationScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT().

◆ GetAttackTypeExists()

bool wsf::cyber::ScenarioExtension::GetAttackTypeExists ( const std::string & aNamedAttack ) const

References mAttackTypesPtr.

◆ GetAttackTypeInputRequirement()

bool wsf::cyber::ScenarioExtension::GetAttackTypeInputRequirement	(	const std::string &	aNamedAttack,
		Effect::InputRequirement	aRequirement ) const

References mAttackTypesPtr, and mEffectTypesPtr.

◆ GetAttackTypes()

AttackTypes & wsf::cyber::ScenarioExtension::GetAttackTypes ( ) const

inline

References mAttackTypesPtr.

Referenced by wsf::cyber::AttackTypes::Get(), wsf::cyber::AttackTypes::Get(), and wsf::cyber::SimulationExtension::Initialize().

◆ GetConstraintTypes()

ConstraintTypes & wsf::cyber::ScenarioExtension::GetConstraintTypes ( ) const

inline

References mConstraintTypesPtr.

Referenced by wsf::cyber::ConstraintTypes::Get(), and wsf::cyber::ConstraintTypes::Get().

◆ GetConstraintTypesExists()

bool wsf::cyber::ScenarioExtension::GetConstraintTypesExists ( const std::string & aNamedConstraint ) const

References mConstraintTypesPtr.

◆ GetEffectTypeExists()

bool wsf::cyber::ScenarioExtension::GetEffectTypeExists ( const std::string & aNamedEffect ) const

References mEffectTypesPtr.

◆ GetEffectTypes()

EffectTypes & wsf::cyber::ScenarioExtension::GetEffectTypes ( ) const

inline

References mEffectTypesPtr.

Referenced by wsf::cyber::EffectTypes::Get(), and wsf::cyber::EffectTypes::Get().

◆ GetProtectTypeExists()

bool wsf::cyber::ScenarioExtension::GetProtectTypeExists ( const std::string & aNamedProtection ) const

References mProtectTypesPtr.

◆ GetProtectTypes()

ProtectTypes & wsf::cyber::ScenarioExtension::GetProtectTypes ( ) const

inline

References mProtectTypesPtr.

Referenced by wsf::cyber::ProtectTypes::Get(), and wsf::cyber::ProtectTypes::Get().

◆ GetTriggerTypeExists()

bool wsf::cyber::ScenarioExtension::GetTriggerTypeExists ( const std::string & aNamedTrigger ) const

References mTriggerTypesPtr.

◆ GetTriggerTypes()

TriggerTypes & wsf::cyber::ScenarioExtension::GetTriggerTypes ( ) const

inline

References mTriggerTypesPtr.

◆ IsDrawEnabled()

bool wsf::cyber::ScenarioExtension::IsDrawEnabled ( ) const

inline

References mDrawEnabled.

◆ ProcessInput()

bool wsf::cyber::ScenarioExtension::ProcessInput ( UtInput & aInput )

overridevirtual

Process potential input for the extension. This method examines the current input command to determine if it is one that is recognized by the extension. If it is one recognized by the extension then it processes the command and returns 'true', otherwise it returns 'false'.

Parameters

aInput a reference to a UtInput object.

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

Exceptions

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

Reimplemented from WsfScenarioExtension.

References mDrawEnabled.

◆ SimulationCreated()

void wsf::cyber::ScenarioExtension::SimulationCreated ( WsfSimulation & aSimulation )

overridevirtual

Called when a simulation has been created. (Technically this is called upon entry to WsfSimulation::Initialize()). This is typically used when a scenario extension also requires a simulation extension. The method would typically register the simulation extension as follows:

aSimulation.RegisterExtension("my_ext", new MySimulationExtension());

Parameters

aSimulation The simulation that is being created. See note below!