Implements the WsfScenarioExtension interface given an extension that is cloneable. More...

#include <WsfScenarioExtension.hpp>

Inheritance diagram for WsfCloneableScenarioExtension:

[legend]

Collaboration diagram for WsfCloneableScenarioExtension:

[legend]

Public Member Functions
	WsfCloneableScenarioExtension (WsfCloneableSimulationExtension *aPrototypePtr)
	~WsfCloneableScenarioExtension () override
bool	ProcessInput (UtInput &aInput) override
void	SimulationCreated (WsfSimulation &aSimulation) override
Public Member Functions inherited from WsfScenarioExtension
	WsfScenarioExtension ()
	~WsfScenarioExtension () override
WsfScenario &	GetScenario () const
WsfApplication &	GetApplication () 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

Protected Attributes
WsfCloneableSimulationExtension *	mPrototypePtr

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

Detailed Description

Implements the WsfScenarioExtension interface given an extension that is cloneable.

Constructor & Destructor Documentation

◆ WsfCloneableScenarioExtension()

WsfCloneableScenarioExtension::WsfCloneableScenarioExtension ( WsfCloneableSimulationExtension * aPrototypePtr )

inline

References mPrototypePtr.

Referenced by wsf::space::AtmosphereScenarioExtension::AtmosphereScenarioExtension(), and wsf::coverage::ScenarioExtension::ScenarioExtension().

◆ ~WsfCloneableScenarioExtension()

WsfCloneableScenarioExtension::~WsfCloneableScenarioExtension ( )

override

References mPrototypePtr.

Member Function Documentation

◆ ProcessInput()

bool WsfCloneableScenarioExtension::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 mPrototypePtr.

◆ SimulationCreated()

void WsfCloneableScenarioExtension::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!