Function Class Reference

An abstract base class for sensor_plot function. More...

#include <Function.hpp>

Inheritance diagram for Function:

Collaboration diagram for Function:

Public Member Functions
	Function (const Function &)=default
	Function (const WsfScenario &aScenario, const std::string &aScriptClassName="")
virtual	~Function ()=default
virtual bool	Execute (WsfSimulation &aSimulation)=0
virtual bool	ProcessInput (UtInput &aInput)=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?

Static Public Member Functions
static bool	IsSensorPlotMode ()

Protected Attributes
WsfPlatformAvailability	mPlatformAvailability

Detailed Description

An abstract base class for sensor_plot function.

Constructor & Destructor Documentation

Function() [1/2]

Function::Function ( const Function & )

default

References Function().

Referenced by AntennaPlotFunction::AntennaPlotFunction(), ClutterTableFunction::ClutterTableFunction(), Function(), HorizontalCoverageFunction::HorizontalCoverageFunction(), MapPlotFunction::MapPlotFunction(), RadarEnvelopeFunction::RadarEnvelopeFunction(), RadarLookupTableFunction::RadarLookupTableFunction(), and VerticalCoverageFunction::VerticalCoverageFunction().

Function() [2/2]

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

References IsSensorPlotMode(), and mPlatformAvailability.

~Function()

virtual Function::~Function ( )

virtualdefault

References Execute(), and ProcessInput().

Member Function Documentation

Execute()

bool Function::Execute ( WsfSimulation & aSimulation )

pure virtual

Implemented in AntennaPlotFunction, ClutterTableFunction, FlightPathAnalysisFunction, HorizontalCoverageFunction, HorizontalMapFunction, RadarEnvelopeFunction, RadarLookupTableFunction, SphericalMapFunction, VerticalCoverageFunction, and VerticalMapFunction.

References WsfSimulation::GetScriptContext(), and WsfObserver::SimulationComplete().

Referenced by AntennaPlotFunction::Execute(), ClutterTableFunction::Execute(), FlightPathAnalysisFunction::Execute(), HorizontalCoverageFunction::Execute(), HorizontalMapFunction::Execute(), RadarEnvelopeFunction::Execute(), RadarLookupTableFunction::Execute(), SphericalMapFunction::Execute(), VerticalCoverageFunction::Execute(), VerticalMapFunction::Execute(), and ~Function().

GetCommand()

const std::string & Function::GetCommand ( ) const

inline

Referenced by HorizontalMapFunction::Execute(), HorizontalMapFunction::ProcessInput(), and HorizontalMapFunction::WriteWSFContours().

GetPlatformAvailability()

const WsfPlatformAvailability & Function::GetPlatformAvailability ( ) const

inline

References mPlatformAvailability.

GetPlotName()

const std::string & Function::GetPlotName ( ) const

inline

GetScenario()

const WsfScenario & Function::GetScenario ( ) const

inline

Referenced by HorizontalMapFunction::BuildContours(), and AntennaPlotFunction::Execute().

IsPlatformAvailabilitySpecified()

bool Function::IsPlatformAvailabilitySpecified ( ) const

inline

Has the user provided a platform_availability block for the plot?

IsSensorPlotMode()

bool Function::IsSensorPlotMode ( )

static

References WsfSensorPlotExtension::IsSensorPlotMode().

Referenced by Function().

ProcessInput()

bool Function::ProcessInput ( UtInput & aInput )

pure virtual

Implemented in AntennaPlotFunction, ClutterTableFunction, FlightPathAnalysisFunction, HorizontalCoverageFunction, HorizontalMapFunction, MapPlotFunction, RadarEnvelopeFunction, RadarLookupTableFunction, SphericalMapFunction, VerticalCoverageFunction, and VerticalMapFunction.

References mPlatformAvailability.

Referenced by AntennaPlotFunction::ProcessInput(), ClutterTableFunction::ProcessInput(), HorizontalCoverageFunction::ProcessInput(), MapPlotFunction::ProcessInput(), RadarEnvelopeFunction::ProcessInput(), RadarLookupTableFunction::ProcessInput(), VerticalCoverageFunction::ProcessInput(), and ~Function().

SetCommand()

void Function::SetCommand ( const std::string & aCommand )

inline

Member Data Documentation

mPlatformAvailability

WsfPlatformAvailability Function::mPlatformAvailability

protected

Referenced by HorizontalMapFunction::Execute(), Function(), GetPlatformAvailability(), HorizontalMapFunction::HorizontalMapFunction(), and ProcessInput().

---

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

• Function.hpp
• Function.cpp