wsf::event::output::ScenarioExtension< DATA, SIM_EXTENSION > Class Template Reference

#include <WsfEventOutputBase.hpp>

Inheritance diagram for wsf::event::output::ScenarioExtension< DATA, SIM_EXTENSION >:

Collaboration diagram for wsf::event::output::ScenarioExtension< DATA, SIM_EXTENSION >:

Public Member Functions
	ScenarioExtension ()
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

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

Detailed Description

template<typename DATA, typename SIM_EXTENSION>
class wsf::event::output::ScenarioExtension< DATA, SIM_EXTENSION >

A base class template for scenario extensions that process "event output" configuration and register a corresponding simulation extension.

Template Parameters

DATA	specifies the data type that stores the configuration, which must derive from Data and can provide a ProcessInput function to read input.
SIM_EXTENSION	specifies the simulation extension that is registered, which must derive from SimulationExtension and whose constructor must take a single argument of type DATA.

Constructor & Destructor Documentation

ScenarioExtension()

template<typename DATA, typename SIM_EXTENSION>

wsf::event::output::ScenarioExtension< DATA, SIM_EXTENSION >::ScenarioExtension ( )

inline

Member Function Documentation

ProcessInput()

template<typename DATA, typename SIM_EXTENSION>

bool wsf::event::output::ScenarioExtension< DATA, SIM_EXTENSION >::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 WsfExtension::GetExtensionName().

SimulationCreated()

template<typename DATA, typename SIM_EXTENSION>

void wsf::event::output::ScenarioExtension< DATA, SIM_EXTENSION >::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!

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().

---

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

• WsfEventOutputBase.hpp