agi.foundation.navigation

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

Class GpsReceiverNoiseModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.navigation.GpsReceiverNoiseModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ConstantGpsReceiverNoiseModel, GpsCommunicationsNoiseModel

public abstract class GpsReceiverNoiseModel
extends DefinitionalObject

A model for the noise at a GPS receiver when receiving a signal from a GPS satellite.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GpsReceiverNoiseModel() Initializes a new instance.
protected	GpsReceiverNoiseModel(GpsReceiverNoiseModel 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(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(GpsReceiverNoiseModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
abstract Scalar	getTotalNoiseScalar(IServiceProvider transmitter, IServiceProvider receiver) Gets a scalar representing the total noise at a specified GPS receiver, in meters, when receiving a signal from a specified GPS satellite transmitter.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, 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

GpsReceiverNoiseModel

protected GpsReceiverNoiseModel()

Initializes a new instance.

GpsReceiverNoiseModel

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

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 abstract boolean checkForSameDefinition(GpsReceiverNoiseModel 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 GpsReceiverNoiseModel.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getTotalNoiseScalar

@Nonnull
public abstract Scalar getTotalNoiseScalar(IServiceProvider transmitter,
                                                     IServiceProvider receiver)

Gets a scalar representing the total noise at a specified GPS receiver, in meters, when receiving a signal from a specified GPS satellite transmitter.

Parameters:

transmitter - The GPS satellite transmitting the signal.

receiver - The GPS receiver receiving the signal.

Returns:

A scalar representing the total noise at the receiver.