agi.foundation.coverage.figureofmerit

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

Class DilutionOfPrecisionFigureOfMerit

java.lang.Object

agi.foundation.coverage.figureofmerit.DilutionOfPrecisionFigureOfMerit

All Implemented Interfaces:

IFigureOfMeritDefinition

public class DilutionOfPrecisionFigureOfMerit
extends Object
implements IFigureOfMeritDefinition

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

Constructor Summary

Constructors

Constructor and Description
DilutionOfPrecisionFigureOfMerit() Initializes a new instance.
DilutionOfPrecisionFigureOfMerit(DilutionOfPrecisionType type) Constructs a new instance based on the given type of dilution of precision.

Method Summary

Modifier and Type	Method and Description
Scalar	getScalarFigureOfMerit(ValueDefinition<CoverageData> coverageResult, IServiceProvider coverageObject) Get a scalar representing the figure of merit for the given data.
DilutionOfPrecisionType	getType() Gets the type of dilution of precision to calculate.
void	setType(DilutionOfPrecisionType value) Sets the type of dilution of precision to calculate.

Methods inherited from class java.lang.Object

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

Constructor Detail

DilutionOfPrecisionFigureOfMerit

public DilutionOfPrecisionFigureOfMerit()

Initializes a new instance.

By default, this computes the Position type.

DilutionOfPrecisionFigureOfMerit

public DilutionOfPrecisionFigureOfMerit(@Nonnull
                                        DilutionOfPrecisionType type)

Constructs a new instance based on the given type of dilution of precision.

Parameters:

type - The type of DOP.

Method Detail

getType

@Nonnull
public final DilutionOfPrecisionType getType()

Gets the type of dilution of precision to calculate.

setType

public final void setType(@Nonnull
                          DilutionOfPrecisionType value)

Sets the type of dilution of precision to calculate.

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.