agi.foundation.coverage.figureofmerit

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

Class NavigationAccuracyAssessedFigureOfMerit

java.lang.Object

agi.foundation.coverage.figureofmerit.NavigationAccuracyAssessedFigureOfMerit

All Implemented Interfaces:

IFigureOfMeritDefinition

public class NavigationAccuracyAssessedFigureOfMerit
extends Object
implements IFigureOfMeritDefinition

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

Constructor Summary

Constructors

Constructor and Description
NavigationAccuracyAssessedFigureOfMerit() Initializes a new instance.
NavigationAccuracyAssessedFigureOfMerit(NavigationAccuracyAssessedType type, PerformanceAssessmentFile performanceAssessmentData) Constructs a new instance based on the given type and performance assessment file.

Method Summary

Modifier and Type	Method and Description
PerformanceAssessmentFile	getPerformanceAssessmentData() Gets the file used to define the performance assessment data.
Scalar	getScalarFigureOfMerit(ValueDefinition<CoverageData> coverageResult, IServiceProvider coverageObject) Get a scalar representing the figure of merit for the given data.
NavigationAccuracyAssessedType	getType() Gets the type of assessed navigation accuracy.
void	setPerformanceAssessmentData(PerformanceAssessmentFile value) Sets the file used to define the performance assessment data.
void	setType(NavigationAccuracyAssessedType value) Sets the type of assessed navigation accuracy.

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationAccuracyAssessedFigureOfMerit

public NavigationAccuracyAssessedFigureOfMerit()

Initializes a new instance.

By default, the NavigationAccuracyAssessedType is NavigationAccuracyAssessedType.POSITION_SIGNAL_IN_SPACE.

NavigationAccuracyAssessedFigureOfMerit

public NavigationAccuracyAssessedFigureOfMerit(@Nonnull
                                               NavigationAccuracyAssessedType type,
                                               PerformanceAssessmentFile performanceAssessmentData)

Constructs a new instance based on the given type and performance assessment file.

Parameters:

type - The type of assessed navigation accuracy to compute.

performanceAssessmentData - A performance assessment file to use when computing.

Method Detail

getType

@Nonnull
public final NavigationAccuracyAssessedType getType()

Gets the type of assessed navigation accuracy.

setType

public final void setType(@Nonnull
                          NavigationAccuracyAssessedType value)

Sets the type of assessed navigation accuracy.

getPerformanceAssessmentData

public final PerformanceAssessmentFile getPerformanceAssessmentData()

Gets the file used to define the performance assessment data.

setPerformanceAssessmentData

public final void setPerformanceAssessmentData(PerformanceAssessmentFile value)

Sets the file used to define the performance assessment 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.