wsf::cyber Namespace Reference

Namespaces
namespace	random
namespace	trigger
namespace	PlatformScriptMethods
namespace	SimulationScriptMethods

Classes
class	ApplicationExtension
	The WSF application extension for cyber. More...
class	Attack
class	AttackParameterObject
	This class is a simple wrapper for an AUX data container. More...
class	ScriptAttackParameterObjectClass
class	AttackParameters
class	ScriptAttackParametersClass
class	AttackTypes
class	Constraint
class	ScriptConstraintClass
class	ConstraintTypes
class	EffectTypes
class	Engagement
	A class that represents the cyber engagements between two platforms. More...
class	ScriptEngagement
	The script interface 'class' for WsfCyberEngagement. More...
class	EngagementManager
class	Event
class	EventManager
class	EventPipe
struct	Observer
class	Protect
class	ProtectTypes
class	ScenarioExtension
	The WSF scenario extension for cyber. More...
class	ScriptExtensions
class	SimulationExtension
class	Visualization
class	VisualizationDraw
class	VisualizationManager

Functions
	UT_DEFINE_SCRIPT_METHOD (ScriptAttackParametersClass, AttackParameters, GetEffectNames, 0, "Array<string>", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptAttackParametersClass, AttackParameters, GetEffectEntryCount, 1, "int", "string")
	UT_DEFINE_SCRIPT_METHOD (ScriptAttackParametersClass, AttackParameters, GetEffectEntryByIndex, 2, "WsfCyberAttackParameterObject", "string, int")
	UT_DEFINE_SCRIPT_METHOD (ScriptAttackParametersClass, AttackParameters, AddParameter, 1, "void", "WsfCyberAttackParameterObject")
	UT_DEFINE_SCRIPT_METHOD (ScriptConstraintClass, Constraint, CurrentResources, 0, "double", "")
	Retrieve the quantity of available cyber resources.
	UT_DEFINE_SCRIPT_METHOD (ScriptConstraintClass, Constraint, TotalResources, 0, "double", "")
	Retrieve the quantity of total cyber resources.
	UT_DEFINE_SCRIPT_METHOD (ScriptConstraintClass, Constraint, ConcurrentAttacks, 1, "int", "string")
	UT_DEFINE_SCRIPT_METHOD (ScriptConstraintClass, Constraint, AttackCountAfterTime, 2, "int", "string, double")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, Attacker, 0, "string", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackerPlatform, 0, "WsfPlatform", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackType, 0, "string", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, Victim, 0, "string", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, VictimPlatform, 0, "WsfPlatform", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, TimeAttackInitiated, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackSuccessThreshold, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackSuccessDraw, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, StatusReportThreshold, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, StatusReportDraw, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, TimeAttackDiscovered, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackDetectionThreshold, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackDetectionDraw, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackAttributionThreshold, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackAttributionDraw, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, TimeAttackRecovery, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, Recovery, 0, "bool", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, TimeScanInitiated, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, ScanDetectionThreshold, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, ScanDetectionDraw, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, ScanAttributionThreshold, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, ScanAttributionDraw, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, ScanDelayTime, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackDeliveryDelayTime, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackDetectionDelayTime, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackRecoveryDelayTime, 0, "double", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, ScanSuccess, 0, "bool", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackSuccess, 0, "bool", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackInProgress, 0, "bool", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, ScanInProgress, 0, "bool", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, ScanFailureReason, 0, "int", "")
	UT_DEFINE_SCRIPT_METHOD (ScriptEngagement, Engagement, AttackFailureReason, 0, "int", "")

Function Documentation

UT_DEFINE_SCRIPT_METHOD() [1/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptAttackParametersClass	,
		AttackParameters	,
		AddParameter	,
		1	,
		"void"	,
		"WsfCyberAttackParameterObject"	)

UT_DEFINE_SCRIPT_METHOD() [2/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptAttackParametersClass	,
		AttackParameters	,
		GetEffectEntryByIndex	,
		2	,
		"WsfCyberAttackParameterObject"	,
		"	string,
		int"	)

UT_DEFINE_SCRIPT_METHOD() [3/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptAttackParametersClass	,
		AttackParameters	,
		GetEffectEntryCount	,
		1	,
		"int"	,
		"string"	)

UT_DEFINE_SCRIPT_METHOD() [4/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptAttackParametersClass	,
		AttackParameters	,
		GetEffectNames	,
		0	,
		"Array<string>"	,
		""	)

References wsf::cyber::AttackParameters::GetEffectNames().

UT_DEFINE_SCRIPT_METHOD() [5/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptConstraintClass	,
		Constraint	,
		AttackCountAfterTime	,
		2	,
		"int"	,
		"	string,
		double"	)

UT_DEFINE_SCRIPT_METHOD() [6/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptConstraintClass	,
		Constraint	,
		ConcurrentAttacks	,
		1	,
		"int"	,
		"string"	)

UT_DEFINE_SCRIPT_METHOD() [7/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptConstraintClass	,
		Constraint	,
		CurrentResources	,
		0	,
		"double"	,
		""	)

Retrieve the quantity of available cyber resources.

UT_DEFINE_SCRIPT_METHOD() [8/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptConstraintClass	,
		Constraint	,
		TotalResources	,
		0	,
		"double"	,
		""	)

Retrieve the quantity of total cyber resources.

UT_DEFINE_SCRIPT_METHOD() [9/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackAttributionDraw	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [10/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackAttributionThreshold	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [11/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackDeliveryDelayTime	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [12/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackDetectionDelayTime	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [13/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackDetectionDraw	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [14/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackDetectionThreshold	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [15/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		Attacker	,
		0	,
		"string"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [16/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackerPlatform	,
		0	,
		"WsfPlatform"	,
		""	)

References WsfSimulation::GetPlatformByName(), WsfScriptContext::GetSIMULATION(), and platformPtr.

UT_DEFINE_SCRIPT_METHOD() [17/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackFailureReason	,
		0	,
		"int"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [18/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackInProgress	,
		0	,
		"bool"	,
		""	)

References success.

UT_DEFINE_SCRIPT_METHOD() [19/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackRecoveryDelayTime	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [20/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackSuccess	,
		0	,
		"bool"	,
		""	)

References success.

UT_DEFINE_SCRIPT_METHOD() [21/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackSuccessDraw	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [22/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackSuccessThreshold	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [23/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		AttackType	,
		0	,
		"string"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [24/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		Recovery	,
		0	,
		"bool"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [25/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		ScanAttributionDraw	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [26/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		ScanAttributionThreshold	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [27/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		ScanDelayTime	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [28/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		ScanDetectionDraw	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [29/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		ScanDetectionThreshold	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [30/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		ScanFailureReason	,
		0	,
		"int"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [31/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		ScanInProgress	,
		0	,
		"bool"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [32/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		ScanSuccess	,
		0	,
		"bool"	,
		""	)

References success.

UT_DEFINE_SCRIPT_METHOD() [33/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		StatusReportDraw	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [34/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		StatusReportThreshold	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [35/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		TimeAttackDiscovered	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [36/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		TimeAttackInitiated	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [37/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		TimeAttackRecovery	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [38/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		TimeScanInitiated	,
		0	,
		"double"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [39/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		Victim	,
		0	,
		"string"	,
		""	)

UT_DEFINE_SCRIPT_METHOD() [40/40]

wsf::cyber::UT_DEFINE_SCRIPT_METHOD	(	ScriptEngagement	,
		Engagement	,
		VictimPlatform	,
		0	,
		"WsfPlatform"	,
		""	)

References platformPtr.