#include <WsfUCI.hpp>

Inheritance diagram for wsf::OMS_UCI_Extension:

[legend]

Collaboration diagram for wsf::OMS_UCI_Extension:

[legend]

Public Member Functions
	OMS_UCI_Extension ()=default
	~OMS_UCI_Extension () override
void	AddedToScenario () override
void	SimulationCreated (WsfSimulation &aSimulation) override
wsf::UCI_ComponentTypes &	GetUCI_ComponentTypes () const
bool	ProcessInput (UtInput &aInput) override
std::shared_ptr< wsf::UCI_Interface >	GetInterface ()
Public Member Functions inherited from WsfScenarioExtension
	WsfScenarioExtension ()
	~WsfScenarioExtension () override
WsfScenario &	GetScenario () const
WsfApplication &	GetApplication () const
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

Static Public Member Functions
static const char *	GetExtensionName ()
static OMS_UCI_Extension &	Get (const WsfScenario &aScenario)
	Return a reference to the UCI scenario extension.

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

Constructor & Destructor Documentation

◆ OMS_UCI_Extension()

wsf::OMS_UCI_Extension::OMS_UCI_Extension ( )

default

References AddedToScenario(), OMS_UCI_Extension(), and SimulationCreated().

Referenced by Get(), and OMS_UCI_Extension().

◆ ~OMS_UCI_Extension()

wsf::OMS_UCI_Extension::~OMS_UCI_Extension ( )

override

References GetInterface().

Member Function Documentation

◆ AddedToScenario()

void wsf::OMS_UCI_Extension::AddedToScenario ( )

overridevirtual

Called when the extension has been added to the scenario. This is typically used to register new component type objects and object factories, e.g.:

WsfScenario& scenario(GetScenario());
WsfMoverTypes::Get(scenario).AddCoreType("MY_MOVER", new MyMover(scenario));
WsfAntennaPatterTypes::Get(scenario).AddObjectFactor(MyAntennaPattern::ObjectFactory);

Script classes must NOT be registered here because they are global to the entire application. They should be registered in WsfApplication::AddedToApplication.

Note: GetScenario() and GetApplication() are now valid.

Reimplemented from WsfScenarioExtension.

References WsfScenarioExtension::GetScenario(), and wsf::UCI_ComponentTypes::RegisterComponentFactory().

Referenced by OMS_UCI_Extension().

◆ Get()

OMS_UCI_Extension & wsf::OMS_UCI_Extension::Get ( const WsfScenario & aScenario )

static

Return a reference to the UCI scenario extension.

References WsfScenario::FindExtension(), GetExtensionName(), OMS_UCI_Extension(), WsfScenarioExtension::WsfScenario, and WsfScenarioExtension::WsfScenarioExtension().

Referenced by wsf::UCI_ComponentTypes::Get(), and wsf::UCI_ComponentTypes::Get().

◆ GetExtensionName()

const char * wsf::OMS_UCI_Extension::GetExtensionName ( )

inlinestatic

Referenced by wsf::UCI_InterfaceExtension::AddedToSimulation(), Get(), and wsf::Register_wsf_uci().

◆ GetInterface()

std::shared_ptr< wsf::UCI_Interface > wsf::OMS_UCI_Extension::GetInterface ( )

Referenced by ProcessInput(), SimulationCreated(), and ~OMS_UCI_Extension().

◆ GetUCI_ComponentTypes()

wsf::UCI_ComponentTypes & wsf::OMS_UCI_Extension::GetUCI_ComponentTypes ( ) const

inline

Referenced by wsf::UCI_ComponentTypes::Get(), and wsf::UCI_ComponentTypes::Get().

◆ ProcessInput()

bool wsf::OMS_UCI_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 GetInterface(), and WsfScenarioExtension::ProcessInput().

◆ SimulationCreated()

void wsf::OMS_UCI_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!