An abstract base class for sensor_plot functions using MapPlotVariables. More...

#include <MapPlotFunction.hpp>

Inheritance diagram for MapPlotFunction:

[legend]

Collaboration diagram for MapPlotFunction:

[legend]

Public Member Functions
	MapPlotFunction ()=default
	MapPlotFunction (const WsfScenario &aScenario, const std::string &aScriptClassName="")
virtual	~MapPlotFunction ()=0
bool	ProcessInput (UtInput &aInput) override
void	RegisterMapPlotVariable (const std::string &aVarName, std::shared_ptr< MapPlotVariable > aVariablePtr)
Public Member Functions inherited from Function
	Function (const Function &)=default
	Function (const WsfScenario &aScenario, const std::string &aScriptClassName="")
virtual	~Function ()=default
virtual bool	Execute (WsfSimulation &aSimulation)=0
const std::string &	GetCommand () const
void	SetCommand (const std::string &aCommand)
const WsfScenario &	GetScenario () const
const std::string &	GetPlotName () const
const WsfPlatformAvailability &	GetPlatformAvailability () const
bool	IsPlatformAvailabilitySpecified () const
	Has the user provided a platform_availability block for the plot?

Protected Attributes
MapPlotVariables	mPlotVariables {}
Protected Attributes inherited from Function
WsfPlatformAvailability	mPlatformAvailability

Additional Inherited Members
Static Public Member Functions inherited from Function
static bool	IsSensorPlotMode ()

Detailed Description

An abstract base class for sensor_plot functions using MapPlotVariables.

Constructor & Destructor Documentation

◆ MapPlotFunction() [1/2]

MapPlotFunction::MapPlotFunction ( )

default

References MapPlotFunction().

Referenced by FlightPathAnalysisFunction::FlightPathAnalysisFunction(), HorizontalMapFunction::HorizontalMapFunction(), MapPlotFunction(), SphericalMapFunction::SphericalMapFunction(), and VerticalMapFunction::VerticalMapFunction().

◆ MapPlotFunction() [2/2]

MapPlotFunction::MapPlotFunction	(	const WsfScenario &	aScenario,
		const std::string &	aScriptClassName = "" )

References Function::Function().

◆ ~MapPlotFunction()

MapPlotFunction::~MapPlotFunction ( )

pure virtualdefault

References RegisterMapPlotVariable().

Member Function Documentation

◆ ProcessInput()

bool MapPlotFunction::ProcessInput ( UtInput & aInput )

overridevirtual

Implements Function.

Reimplemented in SphericalMapFunction, and VerticalMapFunction.

References mPlotVariables, and Function::ProcessInput().

Referenced by FlightPathAnalysisFunction::ProcessInput(), HorizontalMapFunction::ProcessInput(), SphericalMapFunction::ProcessInput(), and VerticalMapFunction::ProcessInput().

◆ RegisterMapPlotVariable()

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

Add runtime defined extension of variable types to the list of available variable computation types for plotting routines.

Parameters

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

References mPlotVariables.

Referenced by WsfSensorPlotExtension::ProcessInput(), and ~MapPlotFunction().

Member Data Documentation

◆ mPlotVariables

MapPlotVariables MapPlotFunction::mPlotVariables {}

protected

Referenced by HorizontalMapFunction::BuildContours(), HorizontalMapFunction::EvaluatePoint(), FlightPathAnalysisFunction::Execute(), HorizontalMapFunction::Execute(), SphericalMapFunction::Execute(), VerticalMapFunction::Execute(), HorizontalMapFunction::GetPdMapFileJsonMetadata(), HorizontalMapFunction::ProcessInput(), ProcessInput(), RegisterMapPlotVariable(), HorizontalMapFunction::WriteGnuPlotFile(), and HorizontalMapFunction::WriteTiffFile().

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

Public Member Functions

Protected Attributes

Additional Inherited Members