#include <StubInterface.hpp>

Inheritance diagram for StubInterface:

[legend]

Collaboration diagram for StubInterface:

[legend]

Public Member Functions
	StubInterface (WsfScenario &aScenario)
	~StubInterface () override
bool	ProcessInput (UtInput &aInput) 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 void	SimulationCreated (WsfSimulation &aSimulation)
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

An interface that provides a mechanism to implement stubs for missing features.

When sensor_plot is built, many 'unnecessary' options may not be provided. For instance, the missile models CSIMS and JAAM are needed in 'wsf', but aren't really needed in sensor_plot. However, if one wants to do a horizontal_map of an actual scenario, the scenario may include definitions that use these 'unnecessary' options and thus cause an input error.

Rather than make the user modify the scenarios simply to run with sensor_plot, this provides a mechanism to define commands and object types that will simply be ignored.

Constructor & Destructor Documentation

◆ StubInterface()

StubInterface::StubInterface ( WsfScenario & aScenario )

References WsfObjectTypeList< T >::Add(), wsf::comm::Types::Get(), WsfMoverTypes::Get(), WsfProcessorTypes::Get(), WsfSensorTypes::Get(), WsfWeaponEffectsTypes::Get(), WsfWeaponTypes::Get(), and WsfScenarioExtension::WsfScenario.

◆ ~StubInterface()

StubInterface::~StubInterface ( )

override

Member Function Documentation

◆ ProcessInput()

bool StubInterface::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.

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