agi.foundation.coverage.figureofmerit

(agi.foundation.navigation-2024r3.jar)

Class NavigationAccuracyPredictedFigureOfMerit

java.lang.Object

agi.foundation.coverage.figureofmerit.NavigationAccuracyPredictedFigureOfMerit

All Implemented Interfaces:

IFigureOfMeritDefinition

public class NavigationAccuracyPredictedFigureOfMerit
extends Object
implements IFigureOfMeritDefinition

A figure of merit which represents the NavigationAccuracyPredicted at any given point over time.

Constructor Summary

Constructors

Constructor and Description
NavigationAccuracyPredictedFigureOfMerit() Initializes a new instance.
NavigationAccuracyPredictedFigureOfMerit(NavigationAccuracyPredictedType type, PredictionSupportFile predictionSupportData) Constructs a new instance based on the given type of navigation accuracy predicted and the corresponding prediction support file.

Method Summary

Modifier and Type	Method and Description
PredictionSupportFile	getPredictionSupportData() Gets the file used to define the prediction support data.
Scalar	getScalarFigureOfMerit(ValueDefinition<CoverageData> coverageResult, IServiceProvider coverageObject) Get a scalar representing the figure of merit for the given data.
NavigationAccuracyPredictedType	getType() Gets the type of predicted navigation accuracy.
void	setPredictionSupportData(PredictionSupportFile value) Sets the file used to define the prediction support data.
void	setType(NavigationAccuracyPredictedType value) Sets the type of predicted navigation accuracy.

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationAccuracyPredictedFigureOfMerit

public NavigationAccuracyPredictedFigureOfMerit()

Initializes a new instance.

By default, the NavigationAccuracyPredictedType is NavigationAccuracyPredictedType.POSITION_SIGNAL_IN_SPACE.

NavigationAccuracyPredictedFigureOfMerit

public NavigationAccuracyPredictedFigureOfMerit(@Nonnull
                                                NavigationAccuracyPredictedType type,
                                                PredictionSupportFile predictionSupportData)

Constructs a new instance based on the given type of navigation accuracy predicted and the corresponding prediction support file.

Parameters:

type - The type of predicted navigation accuracy.

predictionSupportData - The prediction support file.

Method Detail

getType

@Nonnull
public final NavigationAccuracyPredictedType getType()

Gets the type of predicted navigation accuracy.

setType

public final void setType(@Nonnull
                          NavigationAccuracyPredictedType value)

Sets the type of predicted navigation accuracy.

getPredictionSupportData

public final PredictionSupportFile getPredictionSupportData()

Gets the file used to define the prediction support data.

setPredictionSupportData

public final void setPredictionSupportData(PredictionSupportFile value)

Sets the file used to define the prediction support data.

getScalarFigureOfMerit

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

Get a scalar representing the figure of merit for the given data.

Specified by:

getScalarFigureOfMerit in interface IFigureOfMeritDefinition

Parameters:

coverageResult - The coverage results for which to compute a figure of merit.

coverageObject - The object of interest in the figure of merit calculation which implements the IGpsReceiverService.

Returns:

A scalar representing the figure of merit based on the given data.

Throws:

ServiceNotAvailableException - Thrown when coverageObject does not provide IGpsReceiverService.