agi.foundation.celestial

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

Class AtmosphericRefractionModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.AtmosphericRefractionModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

EffectiveRadiusAtmosphericRefractionModel, ItuRP834Version4AtmosphericRefractionModel, SpaceControlFacilityAtmosphericRefractionModel

public abstract class AtmosphericRefractionModel
extends DefinitionalObject

Defines a refraction model.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AtmosphericRefractionModel() Initializes a new instance.
protected	AtmosphericRefractionModel(AtmosphericRefractionModel existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	AtmosphericRefractionModel(CentralBody centralBody) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(AtmosphericRefractionModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
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 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 that the refraction model is associated with.
abstract VectorEvaluator	getEvaluator(EvaluatorGroup group, VectorDisplacement unrefractedDisplacementVector) Gets an evaluator that adjusts the provided displacements relative motion based on atmospheric refraction.
void	setCentralBody(CentralBody value) Sets the central body that the refraction model is associated with.
protected void	validateProperties(EvaluatorGroup group, VectorDisplacement unrefractedDisplacementVector) Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.

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

AtmosphericRefractionModel

protected AtmosphericRefractionModel()

Initializes a new instance.

AtmosphericRefractionModel

protected AtmosphericRefractionModel(CentralBody centralBody)

Initializes a new instance.

Parameters:

centralBody - The central body to which the refraction model applies.

AtmosphericRefractionModel

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

getCentralBody

public final CentralBody getCentralBody()

Gets the central body that the refraction model is associated with.

setCentralBody

public final void setCentralBody(CentralBody value)

Sets the central body that the refraction model is associated with.

getEvaluator

@Nonnull
public abstract VectorEvaluator getEvaluator(@Nonnull
                                                       EvaluatorGroup group,
                                                       @Nonnull
                                                       VectorDisplacement unrefractedDisplacementVector)

Gets an evaluator that adjusts the provided displacements relative motion based on atmospheric refraction.

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.

unrefractedDisplacementVector - The unrefracted displacement vector which will be refracted.

Returns:

An evaluator for the refracted relative motion.

Throws:

ArgumentNullException - Thrown when group or unrefractedDisplacementVector is null.

validateProperties

protected void validateProperties(@Nonnull
                                  EvaluatorGroup group,
                                  @Nonnull
                                  VectorDisplacement unrefractedDisplacementVector)

Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing AtmosphericRefractionModel.getEvaluator(EvaluatorGroup,VectorDisplacement), as well as validate their own properties.

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.

unrefractedDisplacementVector - The unrefracted displacement vector which will be refracted.

Throws:

ArgumentNullException - Thrown when group or unrefractedDisplacementVector is null.

PropertyInvalidException - Thrown when the property CentralBody (get / set) is null.