WsfSensorPlotExtension Class Reference

#include <WsfSensorPlot.hpp>

Inheritance diagram for WsfSensorPlotExtension:

Collaboration diagram for WsfSensorPlotExtension:

Public Member Functions
	WsfSensorPlotExtension (WsfSensorPlotApplicationExtension *aAppExtensionPtr)
	~WsfSensorPlotExtension () override=default
	WsfSensorPlotExtension (const WsfSensorPlotExtension &)=delete
WsfSensorPlotExtension &	operator= (const WsfSensorPlotExtension &)=delete
void	AddedToScenario () override
bool	ProcessInput (UtInput &aInput) override
bool	Complete2 () override
bool	ExecutePlots ()
template<class T>
void	RegisterFunction (const std::string &aCommandName)
void	RegisterMapPlotVariable (const std::string &aVarName, std::shared_ptr< MapPlotVariable > aVariablePtr)
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 void	SimulationCreated (WsfSimulation &aSimulation)
virtual bool	AlwaysCreate ()
Public Member Functions inherited from WsfExtension
virtual	~WsfExtension ()=default
const std::string &	GetExtensionName () const

Static Public Member Functions
static WsfSensorPlotExtension *	Find (WsfScenario &aScenario)
static void	EnableSensorPlotMode ()
static bool	IsSensorPlotMode ()

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

Constructor & Destructor Documentation

WsfSensorPlotExtension() [1/2]

WsfSensorPlotExtension::WsfSensorPlotExtension ( WsfSensorPlotApplicationExtension * aAppExtensionPtr )

explicit

Referenced by Find(), operator=(), and WsfSensorPlotExtension().

~WsfSensorPlotExtension()

WsfSensorPlotExtension::~WsfSensorPlotExtension ( )

overridedefault

WsfSensorPlotExtension() [2/2]

WsfSensorPlotExtension::WsfSensorPlotExtension ( const WsfSensorPlotExtension & )

delete

References WsfSensorPlotExtension().

Member Function Documentation

AddedToScenario()

void WsfSensorPlotExtension::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 RegisterFunction().

Complete2()

bool WsfSensorPlotExtension::Complete2 ( )

overridevirtual

Phase 2 Complete. This is called after all extensions have their Complete() methods called. The contents of this class should remain constant after this call.

Reimplemented from WsfScenarioExtension.

References ExecutePlots(), IsSensorPlotMode(), and ok.

EnableSensorPlotMode()

void WsfSensorPlotExtension::EnableSensorPlotMode ( )

static

Referenced by main(), and operator=().

ExecutePlots()

bool WsfSensorPlotExtension::ExecutePlots

(

)

References ok.

Referenced by Complete2(), main(), and operator=().

Find()

WsfSensorPlotExtension * WsfSensorPlotExtension::Find ( WsfScenario & aScenario )

static

References WsfScenario::FindExtension(), WsfScenarioExtension::WsfScenario, and WsfSensorPlotExtension().

Referenced by main().

IsSensorPlotMode()

bool WsfSensorPlotExtension::IsSensorPlotMode ( )

static

Referenced by Complete2(), Function::IsSensorPlotMode(), and operator=().

operator=()

WsfSensorPlotExtension & WsfSensorPlotExtension::operator= ( const WsfSensorPlotExtension & )

delete

References EnableSensorPlotMode(), ExecutePlots(), IsSensorPlotMode(), and WsfSensorPlotExtension().

ProcessInput()

bool WsfSensorPlotExtension::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 WsfScenarioExtension::GetScenario(), and MapPlotFunction::RegisterMapPlotVariable().

RegisterFunction()

template<class T>

void WsfSensorPlotExtension::RegisterFunction ( const std::string & aCommandName )

inline

References WsfScenarioExtension::WsfScenario.

Referenced by AddedToScenario().

RegisterMapPlotVariable()

void WsfSensorPlotExtension::RegisterMapPlotVariable	(	const std::string &	aVarName,
		std::shared_ptr< MapPlotVariable >	aVariablePtr )

Plugins or projects that register a new MapPlotVariable type must call this at application startup to register their new types.

Once registered the types will be injected into ProcessInput() chain of MapPlotFunction derivatives.

Parameters

aVarName	The script name of the new variable type to be used by MapPlotFunction derived plotting classes.
aVariablePtr	When a plotting value of type varName is encountered this variable function will be invoked to process the data.

---

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

• WsfSensorPlot.hpp
• WsfSensorPlot.cpp