agi.foundation.communications.signalpropagation

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

Class ItuRP840AtmosphericModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalpropagation.ItuRP840AtmosphericModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public abstract class ItuRP840AtmosphericModel
extends DefinitionalObject

Provides atmospheric data for the ITU-R P.840 cloud and fog attenuation model.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ItuRP840AtmosphericModel() Initializes a new instance.
protected	ItuRP840AtmosphericModel(ItuRP840AtmosphericModel 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(ItuRP840AtmosphericModel 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 IParameterizedEvaluator1<Cartographic,ItuRP840AtmosphericValues>	getEvaluator(EvaluatorGroup group, IServiceProvider link) Gets an evaluator that can be used to compute the atmospheric conditions at a given JulianDate and Cartographic location.
IParameterizedEvaluator1<Cartographic,ItuRP840AtmosphericValues>	getEvaluator(IServiceProvider link) Gets an evaluator that can be used to compute the atmospheric conditions at a given JulianDate and Cartographic location.

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

ItuRP840AtmosphericModel

protected ItuRP840AtmosphericModel()

Initializes a new instance.

ItuRP840AtmosphericModel

protected ItuRP840AtmosphericModel(@Nonnull
                                   ItuRP840AtmosphericModel 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(ItuRP840AtmosphericModel 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 ItuRP840AtmosphericModel.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getEvaluator

@Nonnull
public final IParameterizedEvaluator1<Cartographic,ItuRP840AtmosphericValues> getEvaluator(@Nonnull
                                                                                                     IServiceProvider link)

Gets an evaluator that can be used to compute the atmospheric conditions at a given JulianDate and Cartographic location.

Parameters:

link - The link over which the returned evaluator will be evaluated. This service provider is expected to provide ILinkService.

Returns:

An evaluator for this model.

getEvaluator

@Nonnull
public abstract IParameterizedEvaluator1<Cartographic,ItuRP840AtmosphericValues> getEvaluator(@Nonnull
                                                                                                        EvaluatorGroup group,
                                                                                                        @Nonnull
                                                                                                        IServiceProvider link)

Gets an evaluator that can be used to compute the atmospheric conditions at a given JulianDate and Cartographic location. Adds the evaluator to the EvaluatorGroup.

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.

link - The link over which the returned evaluator will be evaluated. This service provider is expected to provide ILinkService.

Returns:

An evaluator for this model.