WSF
WsfScriptObserverExtension Class Reference

#include <WsfScriptObserver.hpp>

Inheritance diagram for WsfScriptObserverExtension:
Collaboration diagram for WsfScriptObserverExtension:

Public Types

using EventMap = std::map<std::string, std::set<std::string>>

Public Member Functions

bool ProcessInput (UtInput &aInput) override
void SimulationCreated (WsfSimulation &aSimulation) override
Public Member Functions inherited from WsfScenarioExtension
 WsfScenarioExtension ()
 ~WsfScenarioExtension () override
WsfScenarioGetScenario () const
WsfApplicationGetApplication () const
virtual void AddedToScenario ()
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

Public Attributes

EventMap mEnabledEvents

Additional Inherited Members

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

Member Typedef Documentation

◆ EventMap

using WsfScriptObserverExtension::EventMap = std::map<std::string, std::set<std::string>>

Member Function Documentation

◆ ProcessInput()

bool WsfScriptObserverExtension::ProcessInput ( UtInput & aInput)
overridevirtual

Process the script input for the scriptObserver.

Parameters
aInputThe input object to be parsed.
Returns
True if the command is handled by this ProcessInput.

Reimplemented from WsfScenarioExtension.

References mEnabledEvents.

◆ SimulationCreated()

void WsfScriptObserverExtension::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
aSimulationThe simulation that is being created. See note below!
Note
This is called upon entry to WsfSimulation::Initialize() and nothing can be assumed about the state of the simulation.
See also
WsfSimulationExtension, WsfApplicationExtension::SimulationCreated

Reimplemented from WsfScenarioExtension.

References WsfExtension::GetExtensionName(), and WsfSimulation::RegisterExtension().

Member Data Documentation

◆ mEnabledEvents

EventMap WsfScriptObserverExtension::mEnabledEvents

Referenced by ProcessInput().


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