agi.foundation.celestial

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

Class WindModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.WindModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ConstantWindModel

public abstract class WindModel
extends DefinitionalObject

Defines a wind model for an atmosphere.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WindModel(CentralBody centralBody) Initializes a new instance.
protected	WindModel(WindModel 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(WindModel 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 wind model is associated with.
abstract VectorEvaluator	getEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider) Gets an instance of an evaluator that can compute the wind.
VectorEvaluator	getEvaluator(IServiceProvider serviceProvider) Gets an instance of an evaluator that can compute the wind.
VectorDependentOnServiceProvider	getRelativeVelocityVector() Gets a VectorDependentOnServiceProvider that calculates the velocity of a specified point relative to the moving atmosphere according to this wind model.
VectorDependentOnServiceProvider	getWindVector() Gets a VectorDependentOnServiceProvider that calculates the wind at a specified point.
void	setCentralBody(CentralBody value) Sets the central body that the wind model is associated with.
protected void	validateProperties(EvaluatorGroup group, IServiceProvider serviceProvider) 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

WindModel

protected WindModel(CentralBody centralBody)

Initializes a new instance.

Parameters:

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

WindModel

protected WindModel(@Nonnull
                    WindModel 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(WindModel 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 WindModel.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 wind model is associated with.

setCentralBody

public final void setCentralBody(CentralBody value)

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

getWindVector

@Nonnull
public final VectorDependentOnServiceProvider getWindVector()

Gets a VectorDependentOnServiceProvider that calculates the wind at a specified point.

getRelativeVelocityVector

@Nonnull
public final VectorDependentOnServiceProvider getRelativeVelocityVector()

Gets a VectorDependentOnServiceProvider that calculates the velocity of a specified point relative to the moving atmosphere according to this wind model.

getEvaluator

@Nonnull
public final VectorEvaluator getEvaluator(@Nonnull
                                                    IServiceProvider serviceProvider)

Gets an instance of an evaluator that can compute the wind.

Parameters:

serviceProvider - The location to use when calculating the value. This service provider must provide the ILocationPointService service.

Returns:

The evaluator that computes the wind.

Throws:

ArgumentNullException - Thrown when serviceProvider is null.

getEvaluator

@Nonnull
public abstract VectorEvaluator getEvaluator(@Nonnull
                                                       EvaluatorGroup group,
                                                       @Nonnull
                                                       IServiceProvider serviceProvider)

Gets an instance of an evaluator that can compute the wind.

Parameters:

group - The group in which to create the evaluator and its dependents.

serviceProvider - The location to use when calculating the value. This service provider must provide the ILocationPointService service.

Returns:

The evaluator that computes the wind.

Throws:

ArgumentNullException - Thrown when group or serviceProvider is null.

validateProperties

protected void validateProperties(@Nonnull
                                  EvaluatorGroup group,
                                  @Nonnull
                                  IServiceProvider serviceProvider)

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 WindModel.getEvaluator(EvaluatorGroup,IServiceProvider), as well as validate their own properties.

Parameters:

group - The group in which to create the evaluator and its dependents.

serviceProvider - The location to use when calculating the value. This service provider must provide the ILocationPointService service.

Throws:

ArgumentNullException - Thrown when group or serviceProvider is null.

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