agi.foundation.navigation.models

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

Class ScalarSaastamoinenTroposphericCorrection

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.Scalar

agi.foundation.navigation.models.ScalarSaastamoinenTroposphericCorrection

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class ScalarSaastamoinenTroposphericCorrection
extends Scalar

A Scalar for calculating the Saastamoinen tropospheric correction. This Scalar is used with the GpsReceiver class to correct pseudorange errors due to the troposphere.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping The types of obliquity mapping used.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScalarSaastamoinenTroposphericCorrection() Initializes a new instance.
	ScalarSaastamoinenTroposphericCorrection(IServiceProvider transmitter, IServiceProvider receiver, RinexMeteorological rinexMeteorologicalFile, ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping obliquityMapping) Initializes a new instance with the specified parameters.
protected	ScalarSaastamoinenTroposphericCorrection(ScalarSaastamoinenTroposphericCorrection existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(Scalar other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(ScalarSaastamoinenTroposphericCorrection 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.
ScalarEvaluator	getEvaluator(EvaluatorGroup group) Gets an evaluator that can be used to evaluate the SaastamoinenTroposphericCorrectionModel.
ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping	getObliquityMapping() Gets the type of mapping to use when calculating the tropospheric delay.
IServiceProvider	getReceiver() Gets the receiver of the signal traveling through the troposphere.
RinexMeteorological	getRinexMeteorologicalFile() Gets the file used to define the meteorological conditions at the receiver.
IServiceProvider	getTransmitter() Gets the transmitter of the signal traveling through the troposphere.
void	setObliquityMapping(ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping value) Sets the type of mapping to use when calculating the tropospheric delay.
void	setReceiver(IServiceProvider value) Sets the receiver of the signal traveling through the troposphere.
void	setRinexMeteorologicalFile(RinexMeteorological value) Sets the file used to define the meteorological conditions at the receiver.
void	setTransmitter(IServiceProvider value) Sets the transmitter of the signal traveling through the troposphere.

Methods inherited from class agi.foundation.geometry.Scalar

add, add, add, add, add, checkForSameDefinition, createScalarDerivative, divide, divide, divide, divide, divide, getEvaluator, multiply, multiply, multiply, multiply, multiply, power, subtract, subtract, subtract, subtract, subtract, toScalar

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

ScalarSaastamoinenTroposphericCorrection

public ScalarSaastamoinenTroposphericCorrection()

Initializes a new instance.

ScalarSaastamoinenTroposphericCorrection

public ScalarSaastamoinenTroposphericCorrection(IServiceProvider transmitter,
                                                IServiceProvider receiver,
                                                RinexMeteorological rinexMeteorologicalFile,
                                                @Nonnull
                                                ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping obliquityMapping)

Initializes a new instance with the specified parameters.

The ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping defines how the dry and wet components of the final tropospheric delay is calculated.

• ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping.SEPARATE_WET_DRY applies a separate mapping coefficient to the dry and wet components.
• ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping.COMBINED_WET_DRY applies a single mapping coefficient to the sum of the dry and wet components.

Parameters:

transmitter - The transmitter of the signal traveling through the troposphere. This is usually the GPS Satellite.

receiver - The receiver of the signal traveling through the troposphere. This is usually the GPS Receiver.

rinexMeteorologicalFile - The file used to define the meteorological conditions at the receiver.

obliquityMapping - The type of mapping to use when calculating the tropospheric delay.

ScalarSaastamoinenTroposphericCorrection

protected ScalarSaastamoinenTroposphericCorrection(@Nonnull
                                                   ScalarSaastamoinenTroposphericCorrection 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.

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(Scalar 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 Scalar

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(ScalarSaastamoinenTroposphericCorrection 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 ScalarSaastamoinenTroposphericCorrection.checkForSameDefinition(agi.foundation.geometry.Scalar) method.

Overrides:

computeCurrentDefinitionHashCode in class Scalar

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.

getEvaluator

public ScalarEvaluator getEvaluator(EvaluatorGroup group)

Gets an evaluator that can be used to evaluate the SaastamoinenTroposphericCorrectionModel.

Specified by:

getEvaluator in class Scalar

Parameters:

group - The EvaluatorGroup used in the evaluation.

Returns:

An evaluator used to evaluate the SaastamoinenTroposphericCorrectionModel.

getReceiver

public final IServiceProvider getReceiver()

Gets the receiver of the signal traveling through the troposphere. This is usually the Gps Receiver's antenna.

setReceiver

public final void setReceiver(IServiceProvider value)

Sets the receiver of the signal traveling through the troposphere. This is usually the Gps Receiver's antenna.

getTransmitter

public final IServiceProvider getTransmitter()

Gets the transmitter of the signal traveling through the troposphere. This is usually the Gps Satellite.

setTransmitter

public final void setTransmitter(IServiceProvider value)

Sets the transmitter of the signal traveling through the troposphere. This is usually the Gps Satellite.

getRinexMeteorologicalFile

public final RinexMeteorological getRinexMeteorologicalFile()

Gets the file used to define the meteorological conditions at the receiver.

setRinexMeteorologicalFile

public final void setRinexMeteorologicalFile(RinexMeteorological value)

Sets the file used to define the meteorological conditions at the receiver.

getObliquityMapping

@Nonnull
public final ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping getObliquityMapping()

Gets the type of mapping to use when calculating the tropospheric delay.

The ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping defines how the dry and wet components of the final tropospheric delay is calculated.

• ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping.SEPARATE_WET_DRY applies a separate mapping coefficient to the dry and wet components.
• ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping.COMBINED_WET_DRY applies a single mapping coefficient to the sum of the dry and wet components.

setObliquityMapping

public final void setObliquityMapping(@Nonnull
                                      ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping value)

Sets the type of mapping to use when calculating the tropospheric delay.

The ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping defines how the dry and wet components of the final tropospheric delay is calculated.

• ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping.SEPARATE_WET_DRY applies a separate mapping coefficient to the dry and wet components.
• ScalarSaastamoinenTroposphericCorrection.TroposphericObliquityMapping.COMBINED_WET_DRY applies a single mapping coefficient to the sum of the dry and wet components.