agi.foundation.coverage.figureofmerit

(agi.foundation.radar-2024r2.jar)

Class RadarFigureOfMerit

java.lang.Object

agi.foundation.coverage.figureofmerit.RadarFigureOfMerit

All Implemented Interfaces:

IFigureOfMeritDefinition

public class RadarFigureOfMerit
extends Object
implements IFigureOfMeritDefinition

A figure of merit based on a SingleTargetRadarLinkScalar representing a radar parameter or other radar related value.

Constructor Summary

Constructors

Constructor and Description
RadarFigureOfMerit() Initializes a new instance.
RadarFigureOfMerit(SingleTargetRadarLinkScalar radarParameter) Initialize a new instance based on the given scalar radar parameter.

Method Summary

Modifier and Type	Method and Description
SingleTargetRadarLinkScalar	getRadarParameter() Gets the scalar radar parameter to use as a template for this figure of merit.
Scalar	getScalarFigureOfMerit(ValueDefinition<CoverageData> coverageResult, IServiceProvider coverageObject) Get a Scalar representing a figure of merit based on the given RadarParameter (get / set).
void	setRadarParameter(SingleTargetRadarLinkScalar value) Sets the scalar radar parameter to use as a template for this figure of merit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RadarFigureOfMerit

public RadarFigureOfMerit()

Initializes a new instance.

RadarFigureOfMerit

public RadarFigureOfMerit(SingleTargetRadarLinkScalar radarParameter)

Initialize a new instance based on the given scalar radar parameter.

Parameters:

radarParameter - The scalar radar parameter to use as a figure of merit.

Method Detail

getRadarParameter

public final SingleTargetRadarLinkScalar getRadarParameter()

Gets the scalar radar parameter to use as a template for this figure of merit. The instances of the IServiceProvider representing the receiver will be replaced with the coverage object when producing the Scalar representing the figure of merit.

setRadarParameter

public final void setRadarParameter(SingleTargetRadarLinkScalar value)

Sets the scalar radar parameter to use as a template for this figure of merit. The instances of the IServiceProvider representing the receiver will be replaced with the coverage object when producing the Scalar representing the figure of merit.

getScalarFigureOfMerit

public final Scalar getScalarFigureOfMerit(ValueDefinition<CoverageData> coverageResult,
                                           IServiceProvider coverageObject)

Get a Scalar representing a figure of merit based on the given RadarParameter (get / set). All instances of the CoverageData.GridPointPlaceholder used in the RadarParameter (get / set) will be replaced with the coverageObject in the new scalar.

Specified by:

getScalarFigureOfMerit in interface IFigureOfMeritDefinition

Parameters:

coverageResult - The result of a coverage calculation for the given coverageObject.

coverageObject - The object of interest in the coverage calculation, which will replace the placeholder in the RadarParameter (get / set).

Returns:

A Scalar representing the figure of merit for the given RadarParameter (get / set).

Throws:

PropertyInvalidException - Thrown if the RadarParameter (get / set) property is null.