GpsReceiver

java.lang.Object
- agi.foundation.infrastructure.DefinitionalObject
- - agi.foundation.navigation.GpsReceiver

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider
```
public class GpsReceiver
extends DefinitionalObject
implements IServiceProvider
```
A Global Positioning System receiver.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`GpsReceiver()` Initializes a new instance.
`protected`	`GpsReceiver(GpsReceiver existingInstance, CopyContext context)` Initializes a new instance as a copy of an existing instance.
	`GpsReceiver(PlatformCollection navigationSatellites, int numberOfChannels, IServiceProvider antenna, double fixedMaskAngle, double constantNoise)` Initializes a new instance of a basic Gps Receiver.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`checkForSameDefinition(DefinitionalObject other)` Checks to determine if another instance has the same definition as this instance and returns `true` if it does.
`protected boolean`	`checkForSameDefinition(GpsReceiver other)` Checks to determine if another instance has the same definition as this instance and returns `true` if it does.
`Object`	`clone(CopyContext context)` Clones this object using the specified context.
`protected int`	`computeCurrentDefinitionHashCode()` Computes a hash code based on the current properties of this object.
`void`	`enumerateDependencies(DependencyEnumerator enumerator)` Enumerates the dependencies of this object by calling `DependencyEnumerator#enumerate(T)` for each object that this object directly depends upon.
`protected void`	`freezeAggregatedObjects()` Called by `DefinitionalObject.freeze()` to also freeze any objects that are considered to be a part of this object.
`IServiceProvider`	`getAntenna()` Gets the antenna of the GPS receiver.
`Evaluator<DilutionOfPrecision>`	`getDilutionOfPrecisionEvaluator()` Returns an evaluator which can compute the `DilutionOfPrecision` for this GPS receiver at a given time.
`Evaluator<DilutionOfPrecision>`	`getDilutionOfPrecisionEvaluator(boolean allowUndefinedDOPs)` Returns an evaluator which can compute the `DilutionOfPrecision` for this GPS receiver at a given time.
`Evaluator<DilutionOfPrecision>`	`getDilutionOfPrecisionEvaluator(EvaluatorGroup group)` Returns an evaluator which can compute the `DilutionOfPrecision` for this GPS receiver at a given time.
`Evaluator<DilutionOfPrecision>`	`getDilutionOfPrecisionEvaluator(EvaluatorGroup group, boolean allowUndefinedDOPs)` Returns an evaluator which can compute the `DilutionOfPrecision` for this GPS receiver at a given time.
`Evaluator<NavigationAccuracyAssessed>`	`getNavigationAccuracyAssessedEvaluator(PerformanceAssessmentFile performanceAssessmentFile)` Returns an evaluator which can compute the `NavigationAccuracyAssessed` for this GPS receiver at a given time.
`Evaluator<NavigationAccuracyAssessed>`	`getNavigationAccuracyAssessedEvaluator(PerformanceAssessmentFile performanceAssessmentFile, AccuracyCalculationPersona persona, EvaluatorGroup group)` Returns an evaluator which can compute the `NavigationAccuracyAssessed` for this GPS receiver at a given time.
`Evaluator<NavigationAccuracyPredicted>`	`getNavigationAccuracyPredictedEvaluator(PredictionSupportFile predictionSupportFile)` Returns an evaluator which can compute the `NavigationAccuracyPredicted` for this GPS receiver at a given time.
`Evaluator<NavigationAccuracyPredicted>`	`getNavigationAccuracyPredictedEvaluator(PredictionSupportFile predictionSupportFile, AccuracyCalculationPersona persona, EvaluatorGroup group)` Returns an evaluator which can compute the `NavigationAccuracyPredicted` for this GPS receiver at a given time.
`Evaluator<NavigationAccuracyPredicted>`	`getNavigationAccuracyPredictedEvaluator(PredictionSupportFile predictionSupportFile, EvaluatorGroup group)` Returns an evaluator which can compute the `NavigationAccuracyPredicted` for this GPS receiver at a given time.
`PlatformCollection`	`getNavigationSatellites()` Gets the collection of navigation satellites from which this receiver can potentially receive a navigation signal.
`GpsReceiverNoiseModel`	`getNoiseModel()` Gets the model for computing the noise in this receiver when receiving a signal from a navigation satellite.
`int`	`getNumberOfChannels()` Gets the number of channels in this receiver.
`DilutionOfPrecisionOptimization`	`getOptimizationCriteria()` Gets the dilution of precision (DOP) value to optimize on when using a `GpsReceiverSolutionType.BEST_N` `ReceiverSolutionType` (`get` / `set`).
`AccessConstraintCollection`	`getReceiverConstraints()` Gets the collection of Access constraints to be applied to the receiver in determining which navigation satellites are usable by it.
`GpsReceiverSolutionType`	`getReceiverSolutionType()` Gets the type of solution to use to decide which satellites to track out of all the satellites that are visible.
`AccessConstraintCollection`	`getSatelliteConstraints()` Gets the collection of Access constraints to be applied to the navigation satellites in determining which ones are usable by the receiver.
`Evaluator<PlatformCollection>`	`getSatelliteTrackingEvaluator()` Returns an evaluator that identifies the satellites that are tracked by the GPS receiver at a given date.
`Evaluator<PlatformCollection>`	`getSatelliteTrackingEvaluator(EvaluatorGroup group)` Returns an evaluator that identifies the satellites that are tracked by the GPS receiver at a given date.
`Evaluator<int[]>`	`getSatelliteTrackingIndexEvaluator()` Returns an evaluator that identifies the satellites that are tracked by the GPS receiver at a given date.
`Evaluator<int[]>`	`getSatelliteTrackingIndexEvaluator(EvaluatorGroup group)` Returns an evaluator that identifies the satellites that are tracked by the GPS receiver at a given date.
`Evaluator<SatelliteUserRangeError>`	`getSatelliteUserRangeErrorEvaluator(IServiceProvider satellite, PerformanceAssessmentFile performanceAssessmentFile)` Returns an evaluator that supplies the user range errors for a satellite at a given date.
`Evaluator<SatelliteUserRangeError>`	`getSatelliteUserRangeErrorEvaluator(IServiceProvider satellite, PerformanceAssessmentFile performanceAssessmentFile, EvaluatorGroup group)` Returns an evaluator that supplies the user range errors for a satellite at a given date.
`Object`	`getService(Class<?> serviceType)` Gets the service object of the specified type.
`void`	`setAntenna(IServiceProvider value)` Sets the antenna of the GPS receiver.
`void`	`setNavigationSatellites(PlatformCollection value)` Sets the collection of navigation satellites from which this receiver can potentially receive a navigation signal.
`void`	`setNoiseModel(GpsReceiverNoiseModel value)` Sets the model for computing the noise in this receiver when receiving a signal from a navigation satellite.
`void`	`setNumberOfChannels(int value)` Sets the number of channels in this receiver.
`void`	`setOptimizationCriteria(DilutionOfPrecisionOptimization value)` Sets the dilution of precision (DOP) value to optimize on when using a `GpsReceiverSolutionType.BEST_N` `ReceiverSolutionType` (`get` / `set`).
`void`	`setReceiverSolutionType(GpsReceiverSolutionType value)` Sets the type of solution to use to decide which satellites to track out of all the satellites that are visible.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GpsReceiver
```
public GpsReceiver()
```
    Initializes a new instance.
    
    The properties of the receiver are initialized to the following values:
    - NumberOfChannels (get / set) = 0. This property must be set before any evaluator can be obtained from the receiver.
    - ReceiverSolutionType (get / set) = GpsReceiverSolutionType.ALL_IN_VIEW
    - OptimizationCriteria (get / set) = DilutionOfPrecisionOptimization.POSITION
    - Antenna (get / set) = null. This property must be set before any evaluator can be obtained from the receiver.
    - NavigationSatellites (get / set) = null. This property must be set before any evaluator can be obtained from the receiver.
    - SatelliteConstraints (get) = empty list. At least one constraint must be added to one of the collections of constraints, or at least one constraint must be applied to the Antenna (get / set), before any evaluator can be obtained from the receiver.
    - ReceiverConstraints (get) = empty list. At least one constraint must be added to one of the collections of constraints, or at least one constraint must be applied to the Antenna (get / set), before any evaluator can be obtained from the receiver.
    - NoiseModel (get / set) = null. This property must be set before any evaluator that requires a noise model can be obtained from the receiver.
  - GpsReceiver
```
public GpsReceiver(PlatformCollection navigationSatellites,
                   int numberOfChannels,
                   IServiceProvider antenna,
                   double fixedMaskAngle,
                   double constantNoise)
```
    Initializes a new instance of a basic Gps Receiver.
    
    An ElevationAngleConstraint will be constructed with the specified fixedMaskAngle and will be added to the ReceiverConstraints (get) collection. The EarthCentralBody required to configure the elevation angle constraint will be obtained from the CentralBodiesFacet instance in the CalculationContext.
    
    The receiver's NoiseModel (get / set) will be set to an instance of the ConstantGpsReceiverNoiseModel which is initialized with the constantNoise value.
    
    The properties of the receiver that are not specified in this constructor are initialized to the following values:
    - GpsReceiverSolutionType = GpsReceiverSolutionType.ALL_IN_VIEW. This property can be changed after the receiver is constructed, if desired.
    - DilutionOfPrecisionOptimization = DilutionOfPrecisionOptimization.POSITION. This property can be changed after the receiver is constructed, if desired. This property is only used when the GpsReceiverSolutionType is set to GpsReceiverSolutionType.BEST_N.
    Parameters:
    
    navigationSatellites - The collection of navigation satellites from which this receiver can potentially receive a navigation signal.
    
    numberOfChannels - The number of satellites that this receiver can simultaneously track.
    
    antenna - The antenna of the GPS receiver. The antenna must provide ILocationPointService and IOrientationAxesService. If it provides IAccessConstraintsService, the service will be queried for additional constraints which will be applied in determining which satellites are visible to the receiver. Usually, an instance of the Platform class is used as an antenna for the receiver.
    
    fixedMaskAngle - The minimum elevation angle, in radians, that is required in order for the satellites to be considered visible to the receiver.
    
    constantNoise - The constant noise value applied to all channels in the receiver, in meters.
  - GpsReceiver
```
protected GpsReceiver(@Nonnull
                      GpsReceiver existingInstance,
                      @Nonnull
                      CopyContext context)
```
    Initializes a new instance as a copy of an existing instance.
    See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.
    
    Parameters:
    
    existingInstance - The existing instance to copy.
    
    context - A CopyContext that controls the depth of the copy.
    
    Throws:
    
    ArgumentNullException - Thrown when existingInstance or context is null.
    
    ArgumentNullException - Thrown when the context is null.
- Method Detail
  - clone
```
public Object clone(CopyContext context)
```
    Clones this object using the specified context.
    
    This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.
    
    A typical implementation of ICloneWithContext:
```
public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}
```
    In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:
    1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
    2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.
    If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.
```
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
```
    If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:
    1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
    2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
    3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.
```
public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;
```
    Specified by:
    
    clone in interface ICloneWithContext
    
    Specified by:
    
    clone in class DefinitionalObject
    
    Parameters:
    
    context - The context to use to perform the copy.
    
    Returns:
    
    A new instance which is a copy of this object.
  - checkForSameDefinition
```
protected final boolean checkForSameDefinition(DefinitionalObject other)
```
    Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).
    
    Specified by:
    
    checkForSameDefinition in class DefinitionalObject
    
    Parameters:
    
    other - The other instance to compare to this one.
    
    Returns:
    
    true if the two objects are defined equivalently; otherwise false.
  - checkForSameDefinition
```
protected boolean checkForSameDefinition(GpsReceiver other)
```
    Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).
    
    Parameters:
    
    other - The other instance to compare to this one.
    
    Returns:
    
    true if the two objects are defined equivalently; otherwise false.
  - computeCurrentDefinitionHashCode
```
protected int computeCurrentDefinitionHashCode()
```
    Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the GpsReceiver.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.
    
    Overrides:
    
    computeCurrentDefinitionHashCode in class DefinitionalObject
    
    Returns:
    
    The computed hash code.
  - enumerateDependencies
```
public void enumerateDependencies(DependencyEnumerator enumerator)
```
    Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
    
    Specified by:
    
    enumerateDependencies in interface IEnumerateDependencies
    
    Overrides:
    
    enumerateDependencies in class DefinitionalObject
    
    Parameters:
    
    enumerator - The enumerator that is informed of the dependencies of this object.
  - freezeAggregatedObjects
```
protected void freezeAggregatedObjects()
```
    Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
    
    Overrides:
    
    freezeAggregatedObjects in class DefinitionalObject
  - getSatelliteTrackingEvaluator
```
@Nonnull
public final Evaluator<PlatformCollection> getSatelliteTrackingEvaluator()
```
    Returns an evaluator that identifies the satellites that are tracked by the GPS receiver at a given date. The satellites are identified as a collection of references to Platform instances.
    The Earth Fixed frame is used for some computations. It is obtained from the EarthCentralBody contained in the CentralBodiesFacet instance in the CalculationContext.
    
    Returns:
    
    An evaluator of the currently tracked GPS satellites.
    
    Throws:
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getSatelliteTrackingEvaluator
```
@Nonnull
public final Evaluator<PlatformCollection> getSatelliteTrackingEvaluator(@Nonnull
                                                                                   EvaluatorGroup group)
```
    Returns an evaluator that identifies the satellites that are tracked by the GPS receiver at a given date. The satellites are identified as a collection of references to Platform instances.
    The Earth Fixed frame is used for some computations. It is obtained from the EarthCentralBody contained in the CentralBodiesFacet instance in the CalculationContext.
    
    Parameters:
    
    group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.
    
    Returns:
    
    An evaluator of the currently tracked GPS satellites.
    
    Throws:
    
    ArgumentNullException - Thrown when the group is null.
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getSatelliteTrackingIndexEvaluator
```
@Nonnull
public final Evaluator<int[]> getSatelliteTrackingIndexEvaluator()
```
    Returns an evaluator that identifies the satellites that are tracked by the GPS receiver at a given date. The satellites are identified as indices into the NavigationSatellites (get / set) collection.
    The Earth Fixed frame is used for some computations. It is obtained from the EarthCentralBody contained in the CentralBodiesFacet instance in the CalculationContext.
    
    Returns:
    
    An evaluator of the currently tracked GPS satellites.
    
    Throws:
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getSatelliteTrackingIndexEvaluator
```
@Nonnull
public final Evaluator<int[]> getSatelliteTrackingIndexEvaluator(@Nonnull
                                                                           EvaluatorGroup group)
```
    Returns an evaluator that identifies the satellites that are tracked by the GPS receiver at a given date. The satellites are identified as indices into the NavigationSatellites (get / set) collection.
    The Earth Fixed frame is used for some computations. It is obtained from the EarthCentralBody contained in the CentralBodiesFacet instance in the CalculationContext.
    
    Parameters:
    
    group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.
    
    Returns:
    
    An evaluator of the currently tracked GPS satellites.
    
    Throws:
    
    ArgumentNullException - Thrown when group is null.
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getSatelliteUserRangeErrorEvaluator
```
@Nonnull
public final Evaluator<SatelliteUserRangeError> getSatelliteUserRangeErrorEvaluator(@Nonnull
                                                                                              IServiceProvider satellite,
                                                                                              @Nonnull
                                                                                              PerformanceAssessmentFile performanceAssessmentFile)
```
    Returns an evaluator that supplies the user range errors for a satellite at a given date.
    
    Parameters:
    
    satellite - The GPS satellite for which to obtain the user range error. The satellite instance must provide IGpsPrnService and ILocationPointService.
    
    performanceAssessmentFile - The Performance Assessment File (PAF) containing the ephemeris and clock errors for the navigation satellites over a period of time.
    
    Returns:
    
    An evaluator of the user range errors for a satellite, along the line-of-sight between the receiver antenna and the satellite.
    
    Throws:
    
    ServiceNotAvailableException - Thrown when this GPS receiver's GpsSatelliteExtension does not have the IGpsPrnService.
  - getSatelliteUserRangeErrorEvaluator
```
public final Evaluator<SatelliteUserRangeError> getSatelliteUserRangeErrorEvaluator(@Nonnull
                                                                                    IServiceProvider satellite,
                                                                                    @Nonnull
                                                                                    PerformanceAssessmentFile performanceAssessmentFile,
                                                                                    @Nonnull
                                                                                    EvaluatorGroup group)
```
    Returns an evaluator that supplies the user range errors for a satellite at a given date.
    
    Parameters:
    
    satellite - The GPS satellite for which to obtain the user range error. The satellite instance must provide IGpsPrnService and ILocationPointService.
    
    performanceAssessmentFile - The Performance Assessment File (PAF) containing the ephemeris and clock errors for the navigation satellites over a period of time.
    
    group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.
    
    Returns:
    
    An evaluator of the user range errors for a satellite, along the line-of-sight between the receiver antenna and the satellite.
    
    Throws:
    
    ServiceNotAvailableException - Thrown when this GPS receiver's GpsSatelliteExtension does not have the IGpsPrnService.
    
    ArgumentNullException - Thrown when satellite, performanceAssessmentFile, or group is null.
  - getDilutionOfPrecisionEvaluator
```
@Nonnull
public final Evaluator<DilutionOfPrecision> getDilutionOfPrecisionEvaluator()
```
    Returns an evaluator which can compute the DilutionOfPrecision for this GPS receiver at a given time.
    
    Returns:
    
    An evaluator of dilution of precision.
    
    Throws:
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getDilutionOfPrecisionEvaluator
```
@Nonnull
public final Evaluator<DilutionOfPrecision> getDilutionOfPrecisionEvaluator(boolean allowUndefinedDOPs)
```
    Returns an evaluator which can compute the DilutionOfPrecision for this GPS receiver at a given time.
    
    Parameters:
    
    allowUndefinedDOPs - If true, the returned DilutionOfPrecision will have it's Undefined Property set to true if less than 4 satellites are used instead of throwing an exception.
    
    Returns:
    
    An evaluator of dilution of precision.
    
    Throws:
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getDilutionOfPrecisionEvaluator
```
@Nonnull
public final Evaluator<DilutionOfPrecision> getDilutionOfPrecisionEvaluator(@Nonnull
                                                                                      EvaluatorGroup group)
```
    Returns an evaluator which can compute the DilutionOfPrecision for this GPS receiver at a given time.
    
    Parameters:
    
    group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.
    
    Returns:
    
    An evaluator of dilution of precision.
    
    Throws:
    
    ArgumentNullException - Thrown when the group is null.
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getDilutionOfPrecisionEvaluator
```
@Nonnull
public final Evaluator<DilutionOfPrecision> getDilutionOfPrecisionEvaluator(@Nonnull
                                                                                      EvaluatorGroup group,
                                                                                      boolean allowUndefinedDOPs)
```
    Returns an evaluator which can compute the DilutionOfPrecision for this GPS receiver at a given time.
    
    Parameters:
    
    group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.
    
    allowUndefinedDOPs - If true, the returned DilutionOfPrecision will have it's Undefined Property set to true if less than 4 satellites are used instead of throwing an exception.
    
    Returns:
    
    An evaluator of dilution of precision.
    
    Throws:
    
    ArgumentNullException - Thrown when the group is null.
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getNavigationAccuracyAssessedEvaluator
```
@Nonnull
public final Evaluator<NavigationAccuracyAssessed> getNavigationAccuracyAssessedEvaluator(@Nonnull
                                                                                                    PerformanceAssessmentFile performanceAssessmentFile)
```
    Returns an evaluator which can compute the NavigationAccuracyAssessed for this GPS receiver at a given time.
    This method will use the default AccuracyCalculationPersona of AccuracyCalculationPersona.DILIGENT.
    
    Parameters:
    
    performanceAssessmentFile - The Performance Assessment File (PAF) containing the ephemeris and clock errors for the GPS satellites over a period of time.
    
    Returns:
    
    An evaluator of assessed navigation accuracy.
    
    Throws:
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getNavigationAccuracyAssessedEvaluator
```
@Nonnull
public final Evaluator<NavigationAccuracyAssessed> getNavigationAccuracyAssessedEvaluator(@Nonnull
                                                                                                    PerformanceAssessmentFile performanceAssessmentFile,
                                                                                                    @Nonnull
                                                                                                    AccuracyCalculationPersona persona,
                                                                                                    @Nonnull
                                                                                                    EvaluatorGroup group)
```
    Returns an evaluator which can compute the NavigationAccuracyAssessed for this GPS receiver at a given time.
    
    Parameters:
    
    performanceAssessmentFile - The Performance Assessment File (PAF) containing the ephemeris and clock errors for the GPS satellites over a period of time.
    
    persona - The AccuracyCalculationPersona used to define how this evaluator will react when no data is available for some satellites, ore too few satellites are available.
    
    group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.
    
    Returns:
    
    An evaluator of assessed navigation accuracy.
    
    Throws:
    
    ArgumentNullException - Thrown when the group or performanceAssessmentFile is null.
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getNavigationAccuracyPredictedEvaluator
```
@Nonnull
public final Evaluator<NavigationAccuracyPredicted> getNavigationAccuracyPredictedEvaluator(@Nonnull
                                                                                                      PredictionSupportFile predictionSupportFile)
```
    Returns an evaluator which can compute the NavigationAccuracyPredicted for this GPS receiver at a given time.
    The AccuracyCalculationPersona is set to AccuracyCalculationPersona.DILIGENT by default.
    
    Parameters:
    
    predictionSupportFile - The prediction support file (PSF) to be used to compute the predicted accuracy.
    
    Returns:
    
    An evaluator of predicted navigation accuracy.
    
    Throws:
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getNavigationAccuracyPredictedEvaluator
```
@Nonnull
public final Evaluator<NavigationAccuracyPredicted> getNavigationAccuracyPredictedEvaluator(@Nonnull
                                                                                                      PredictionSupportFile predictionSupportFile,
                                                                                                      @Nonnull
                                                                                                      EvaluatorGroup group)
```
    Returns an evaluator which can compute the NavigationAccuracyPredicted for this GPS receiver at a given time.
    
    Parameters:
    
    predictionSupportFile - The prediction support file (PSF) to be used to compute the predicted accuracy.
    
    group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.
    
    Returns:
    
    An evaluator of predicted navigation accuracy.
    
    Throws:
    
    ArgumentNullException - Thrown when the group is null.
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getNavigationAccuracyPredictedEvaluator
```
@Nonnull
public final Evaluator<NavigationAccuracyPredicted> getNavigationAccuracyPredictedEvaluator(@Nonnull
                                                                                                      PredictionSupportFile predictionSupportFile,
                                                                                                      @Nonnull
                                                                                                      AccuracyCalculationPersona persona,
                                                                                                      @Nonnull
                                                                                                      EvaluatorGroup group)
```
    Returns an evaluator which can compute the NavigationAccuracyPredicted for this GPS receiver at a given time.
    
    Parameters:
    
    predictionSupportFile - The prediction support file (PSF) to be used to compute the predicted accuracy.
    
    persona - The AccuracyCalculationPersona used to define how this evaluator will react when no data is available for some satellites.
    
    group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.
    
    Returns:
    
    An evaluator of predicted navigation accuracy.
    
    Throws:
    
    ArgumentNullException - Thrown when the group is null.
    
    ServiceNotAvailableException - Thrown when this GPS receiver's Antenna (get / set) does not have the ILocationPointService or the IOrientationAxesService.
  - getNumberOfChannels
```
public final int getNumberOfChannels()
```
    Gets the number of channels in this receiver. This is the number of satellites that can be tracked.
  - setNumberOfChannels
```
public final void setNumberOfChannels(int value)
```
    Sets the number of channels in this receiver. This is the number of satellites that can be tracked.
  - getReceiverSolutionType
```
@Nonnull
public final GpsReceiverSolutionType getReceiverSolutionType()
```
    Gets the type of solution to use to decide which satellites to track out of all the satellites that are visible.
  - setReceiverSolutionType
```
public final void setReceiverSolutionType(@Nonnull
                                          GpsReceiverSolutionType value)
```
    Sets the type of solution to use to decide which satellites to track out of all the satellites that are visible.
  - getOptimizationCriteria
```
@Nonnull
public final DilutionOfPrecisionOptimization getOptimizationCriteria()
```
    Gets the dilution of precision (DOP) value to optimize on when using a GpsReceiverSolutionType.BEST_N ReceiverSolutionType (get / set).
  - setOptimizationCriteria
```
public final void setOptimizationCriteria(@Nonnull
                                          DilutionOfPrecisionOptimization value)
```
    Sets the dilution of precision (DOP) value to optimize on when using a GpsReceiverSolutionType.BEST_N ReceiverSolutionType (get / set).
  - getAntenna
```
public final IServiceProvider getAntenna()
```
    Gets the antenna of the GPS receiver.
    The antenna must provide ILocationPointService and IOrientationAxesService. If it provides IAccessConstraintsService, the service will be queried for additional constraints which will be applied in determining which satellites are visible to the receiver. Usually, an instance of the Platform class is used as an antenna for the receiver.
  - setAntenna
```
public final void setAntenna(IServiceProvider value)
```
    Sets the antenna of the GPS receiver.
    The antenna must provide ILocationPointService and IOrientationAxesService. If it provides IAccessConstraintsService, the service will be queried for additional constraints which will be applied in determining which satellites are visible to the receiver. Usually, an instance of the Platform class is used as an antenna for the receiver.
  - getNoiseModel
```
public final GpsReceiverNoiseModel getNoiseModel()
```
    Gets the model for computing the noise in this receiver when receiving a signal from a navigation satellite.
  - setNoiseModel
```
public final void setNoiseModel(GpsReceiverNoiseModel value)
```
    Sets the model for computing the noise in this receiver when receiving a signal from a navigation satellite.
  - getSatelliteConstraints
```
public final AccessConstraintCollection getSatelliteConstraints()
```
    Gets the collection of Access constraints to be applied to the navigation satellites in determining which ones are usable by the receiver.
  - getReceiverConstraints
```
public final AccessConstraintCollection getReceiverConstraints()
```
    Gets the collection of Access constraints to be applied to the receiver in determining which navigation satellites are usable by it.
  - getNavigationSatellites
```
public final PlatformCollection getNavigationSatellites()
```
    Gets the collection of navigation satellites from which this receiver can potentially receive a navigation signal.
  - setNavigationSatellites
```
public final void setNavigationSatellites(PlatformCollection value)
```
    Sets the collection of navigation satellites from which this receiver can potentially receive a navigation signal.
  - getService
```
@Nullable
public Object getService(@Nonnull
                                    Class<?> serviceType)
```
    Gets the service object of the specified type.
    
    Specified by:
    
    getService in interface IServiceProvider
    
    Parameters:
    
    serviceType - An object that specifies the type of service object to get.
    
    Returns:
    
    The found service, or null if the service does not exist.
    
    Throws:
    
    ArgumentNullException - Thrown when serviceType is null.

Class GpsReceiver

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

Methods inherited from class java.lang.Object

Constructor Detail

GpsReceiver

GpsReceiver

Method Detail

clone

checkForSameDefinition

checkForSameDefinition

computeCurrentDefinitionHashCode

enumerateDependencies

freezeAggregatedObjects

getSatelliteTrackingEvaluator

getSatelliteTrackingEvaluator

getSatelliteTrackingIndexEvaluator

getSatelliteTrackingIndexEvaluator

getSatelliteUserRangeErrorEvaluator

getSatelliteUserRangeErrorEvaluator

getDilutionOfPrecisionEvaluator

getDilutionOfPrecisionEvaluator

getDilutionOfPrecisionEvaluator

getDilutionOfPrecisionEvaluator

getNavigationAccuracyAssessedEvaluator

getNavigationAccuracyAssessedEvaluator

getNavigationAccuracyPredictedEvaluator

getNavigationAccuracyPredictedEvaluator

getNavigationAccuracyPredictedEvaluator

getNumberOfChannels

setNumberOfChannels

getReceiverSolutionType

setReceiverSolutionType

getOptimizationCriteria

setOptimizationCriteria

getAntenna

setAntenna

getNoiseModel

setNoiseModel

getSatelliteConstraints

getReceiverConstraints

getNavigationSatellites

setNavigationSatellites

getService