WsfScriptManager Class Reference

Provides the overall management of the scripting capability within the application and scenarios. More...

#include <WsfScriptManager.hpp>

Public Member Functions
	WsfScriptManager (WsfScenario *aScenarioPtr, UtScriptEnvironment *aScriptEnvironmentPtr)
	WsfScriptManager (const WsfScriptManager &aSrc)
	~WsfScriptManager ()
bool	ProcessInput (UtInput &aInput)
bool	Add (std::unique_ptr< UtScriptClass > aClassPtr)
bool	ExecuteScript (double aSimTime, WsfStringId aScriptId)
WsfScriptContext &	GetContext ()
bool	ScriptListingEnabled () const
bool	ScriptWritesEnabled () const
	Return the 'debug_writes' flags for the global context.

Static Public Member Functions
static void	RegisterTypes (UtScriptTypes *aTypePtr)
	Register all of the script types that are part of the core.
static UtScriptTypes &	GetTypes ()

Detailed Description

Provides the overall management of the scripting capability within the application and scenarios.

Constructor & Destructor Documentation

WsfScriptManager() [1/2]

WsfScriptManager::WsfScriptManager	(	WsfScenario *	aScenarioPtr,
		UtScriptEnvironment *	aScriptEnvironmentPtr )

Referenced by ScriptListingEnabled(), and WsfScriptManager().

WsfScriptManager() [2/2]

WsfScriptManager::WsfScriptManager

(

const WsfScriptManager &

aSrc

)

References WsfScriptManager().

~WsfScriptManager()

WsfScriptManager::~WsfScriptManager

(

)

Member Function Documentation

Add()

bool WsfScriptManager::Add

(

std::unique_ptr< UtScriptClass >

aClassPtr

)

References ok.

ExecuteScript()

bool WsfScriptManager::ExecuteScript	(	double	aSimTime,
		WsfStringId	aScriptId )

Execute a globally defined script with the specified string id.

Returns

true if successful or false if not (script doesn't exist).

GetContext()

WsfScriptContext & WsfScriptManager::GetContext

(

)

Provides access to the script manager's script context.

Returns

a reference to the WsfScriptContext object associated with the script manager.

GetTypes()

UtScriptTypes & WsfScriptManager::GetTypes ( )

static

Provides access to the types that have been registered with the script manager.

Returns

a reference to the UtScriptTypes object associated with the script manager.

Referenced by WsfXIO_ScriptService::CheckParams(), WsfXIO_ScriptService::GetEntryFromEnumerationScript(), WsfScenario::ProcessInputP(), and WsfXIO_ScriptService::StoreScript().

ProcessInput()

bool WsfScriptManager::ProcessInput

(

UtInput &

aInput

)

RegisterTypes()

void WsfScriptManager::RegisterTypes ( UtScriptTypes * aTypePtr )

static

Register all of the script types that are part of the core.

References WsfRoute::CreateIteratorScriptClass(), WsfAssociationMessage::CreateScriptClass(), WsfCommandChain::CreateScriptClass(), WsfControlMessage::CreateScriptClass(), WsfDraw::CreateScriptClass(), WsfEventPipeInterface::CreateScriptClass(), WsfImage::CreateScriptClass(), WsfImageMessage::CreateScriptClass(), WsfLocalTrack::CreateScriptClass(), WsfLocalTrackStatus::CreateScriptClass(), WsfPassiveSensor::CreateScriptClass(), WsfRoute::CreateScriptClass(), WsfRouteFinder::CreateScriptClass(), WsfRouteNetwork::CreateScriptClass(), WsfScriptStateMachine::CreateScriptClass(), WsfStatusMessage::CreateScriptClass(), WsfTaskAssignMessage::CreateScriptClass(), WsfTaskCancelMessage::CreateScriptClass(), WsfTaskControlMessage::CreateScriptClass(), WsfTaskStatusMessage::CreateScriptClass(), WsfTrackDropMessage::CreateScriptClass(), WsfTrackId::CreateScriptClass(), WsfTrackManager::CreateScriptClass(), WsfTrackMessage::CreateScriptClass(), WsfTrackNotifyMessage::CreateScriptClass(), WsfVideoMessage::CreateScriptClass(), WsfVisualization::CreateScriptClass(), WsfWaypoint::CreateScriptClass(), WsfZoneRouteFinder::CreateScriptClass(), WsfRadarSignature::RegisterScriptMethods(), WsfSensorProcessor::RegisterScriptMethods(), and WsfTask::RegisterScriptTypes().

Referenced by WsfApplication::WsfApplication().

ScriptListingEnabled()

bool WsfScriptManager::ScriptListingEnabled

(

)

const

References ScriptWritesEnabled(), and WsfScriptManager().

ScriptWritesEnabled()

bool WsfScriptManager::ScriptWritesEnabled

(

)

const

Return the 'debug_writes' flags for the global context.

Referenced by ScriptListingEnabled().

---

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

• WsfScriptManager.hpp
• WsfScriptManager.cpp