agi.foundation.communications.signalpropagation

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

Class RefractiveIndexStructureParameterModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.ScalarDependentOnServiceProvider

agi.foundation.communications.signalpropagation.RefractiveIndexStructureParameterModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

HufnagelValleyRefractiveIndexStructureParameterModel

public abstract class RefractiveIndexStructureParameterModel
extends ScalarDependentOnServiceProvider

Base class for a modeling the refractive index structure parameter Cn².

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RefractiveIndexStructureParameterModel(RefractiveIndexStructureParameterModel existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	RefractiveIndexStructureParameterModel(ScalarDependentOnServiceProvider windSpeedModel, CentralBody centralBody) Initializes a new instance with a given wind speed model and central body used as the altitude reference.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(RefractiveIndexStructureParameterModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(ScalarDependentOnServiceProvider 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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
CentralBody	getCentralBody() Gets the central body used as the altitude reference.
ScalarDependentOnServiceProvider	getWindSpeedModel() Gets the wind speed model.
void	setCentralBody(CentralBody value) Sets the central body used as the altitude reference.
void	setWindSpeedModel(ScalarDependentOnServiceProvider value) Sets the wind speed model.

Methods inherited from class agi.foundation.geometry.ScalarDependentOnServiceProvider

applyServiceProvider, checkForSameDefinition, getEvaluator, getEvaluator, toScalarDependentOnServiceProvider, toScalarDependentOnServiceProvider

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, 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

RefractiveIndexStructureParameterModel

protected RefractiveIndexStructureParameterModel(ScalarDependentOnServiceProvider windSpeedModel,
                                                 CentralBody centralBody)

Initializes a new instance with a given wind speed model and central body used as the altitude reference.

Parameters:

windSpeedModel - The wind speed model which computes wind speed in m/s for a given time.

centralBody - The central body used as the altitude reference.

RefractiveIndexStructureParameterModel

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

getWindSpeedModel

public final ScalarDependentOnServiceProvider getWindSpeedModel()

Gets the wind speed model.

setWindSpeedModel

public final void setWindSpeedModel(ScalarDependentOnServiceProvider value)

Sets the wind speed model.

getCentralBody

public final CentralBody getCentralBody()

Gets the central body used as the altitude reference.

setCentralBody

public final void setCentralBody(CentralBody value)

Sets the central body used as the altitude reference.

checkForSameDefinition

protected final boolean checkForSameDefinition(ScalarDependentOnServiceProvider 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 ScalarDependentOnServiceProvider

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

Overrides:

computeCurrentDefinitionHashCode in class ScalarDependentOnServiceProvider

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.