#include <WsfRIPRManager.hpp>

Inheritance diagram for WsfRIPR_ModuleSetup:

[legend]

Collaboration diagram for WsfRIPR_ModuleSetup:

[legend]

Public Member Functions
	WsfRIPR_ModuleSetup (WsfScenario &aScenario)
	~WsfRIPR_ModuleSetup () 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
Public Member Functions inherited from WsfRIPRManagerData
	WsfRIPRManagerData (WsfScenario &aScenario)
	~WsfRIPRManagerData ()
bool	ProcessRIPR_Input (UtInput &aInput)
	Initialize the XIO extension that manages network requests for RIPR information.

Additional Inherited Members
Public Attributes inherited from WsfRIPRManagerData
WsfScenario *	mScenarioPtr
Protected Member Functions inherited from WsfExtension
void	InitializeExtensionName (const std::string &aName)

Constructor & Destructor Documentation

◆ WsfRIPR_ModuleSetup()

WsfRIPR_ModuleSetup::WsfRIPR_ModuleSetup ( WsfScenario & aScenario )

References WsfObjectTypeList< T >::Add(), WsfProcessorTypes::Get(), WsfRIPRManagerData::WsfRIPRManagerData(), and WsfScenarioExtension::WsfScenario.

◆ ~WsfRIPR_ModuleSetup()

WsfRIPR_ModuleSetup::~WsfRIPR_ModuleSetup ( )

override

References WsfRIPRJobBoard::DependencyClearAll(), and WsfRIPRJob::Reset().

Member Function Documentation

◆ ProcessInput()

bool WsfRIPR_ModuleSetup::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 WsfRIPRManagerData::ProcessRIPR_Input().

◆ SimulationCreated()

void WsfRIPR_ModuleSetup::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 files: