MapPlotVariable Class Reference

#include <MapPlotVariable.hpp>

Collaboration diagram for MapPlotVariable:

Classes
class	SharedData

Public Member Functions
	MapPlotVariable (double aInitValue)
virtual	~MapPlotVariable ()=default
double	GetInitialValue () const
virtual bool	ProcessInput (UtInput &aInput)
virtual bool	Initialize (WsfSimulation &aSimulation, const SharedData &aSharedData)
virtual double	Evaluate (double aSimTime, WsfSimulation *aSimulationPtr, double aValue, WsfSensor *aSensorPtr, WsfSensorResult &aResult) const =0

Protected Attributes
const SharedData *	mSharedDataPtr {nullptr}

Detailed Description

Pure abstract interface extension class to be used by MapPlotFunction types for invoking runtime defined plotting computations.

This interface type allows users to define custom plotting routines in horizontal_map, vertical_map, and spherical_map.

Constructor & Destructor Documentation

MapPlotVariable()

MapPlotVariable::MapPlotVariable ( double aInitValue )

inline

~MapPlotVariable()

virtual MapPlotVariable::~MapPlotVariable ( )

virtualdefault

Member Function Documentation

Evaluate()

virtual double MapPlotVariable::Evaluate ( double aSimTime, WsfSimulation * aSimulationPtr, double aValue, WsfSensor * aSensorPtr, WsfSensorResult & aResult ) const

pure virtual

Performs the variable's evaluation logic between the sensor and target.

Parameters

aSimTime	The current time of the simulation in seconds since the beginning of the simulation.
aSimulationPtr	The simulation currently being executed.
aValue	The current or initial value of the variable.
aSensorPtr	The sensor performing the detection attempt of the target.
aResult	The electronic warfare result from the corresponding WsfEM_Interaction.

Returns

The custom value computed by the extension.

GetInitialValue()

double MapPlotVariable::GetInitialValue ( ) const

inline

Get the default value for this computation type.

Returns

Default value (in units known only to the derived type).

Initialize()

virtual bool MapPlotVariable::Initialize ( WsfSimulation & aSimulation, const SharedData & aSharedData )

inlinevirtual

Initializes the map plot variable.

Parameters

aSimulation	The currently active simulation.
aSharedData	The shared data across the variables for sharing common data set.

Returns

True by default, False if failed initialization in a derived class.

References mSharedDataPtr.

ProcessInput()

virtual bool MapPlotVariable::ProcessInput ( UtInput & aInput )

inlinevirtual

Process an input for the variable.

Parameters

aInput

Check and process this block of script.

Returns

True if the script block was processed by this extension, False if the extension ignored the script block.

Member Data Documentation

mSharedDataPtr

const SharedData* MapPlotVariable::mSharedDataPtr {nullptr}

protected

Referenced by Initialize().

---

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

• MapPlotVariable.hpp