agi.foundation.celestial

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

Class ConstantWindModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.WindModel

agi.foundation.celestial.ConstantWindModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class ConstantWindModel
extends WindModel

Represents a constant wind speed and direction.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ConstantWindModel() Initializes a new instance with a default central body of Earth and no wind.
protected	ConstantWindModel(ConstantWindModel existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	ConstantWindModel(double windDirection, double horizontalWindSpeed, double verticalWindSpeed) Initializes a new instance with a default central body of Earth and the specified parameters.
	ConstantWindModel(double windDirection, double horizontalWindSpeed, double verticalWindSpeed, CentralBody centralBody) Initializes a new instance with the specified parameters.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(ConstantWindModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(WindModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
VectorEvaluator	getEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider) Creates an instance of an evaluator that can compute the wind.
double	getHorizontalWindSpeed() Gets the horizontal speed of the wind in meters/second.
double	getVerticalWindSpeed() Gets the vertical speed of the wind in meters/second.
double	getWindDirection() Gets the direction the wind is coming from in radians, measured clockwise from North toward East.
void	setHorizontalWindSpeed(double value) Sets the horizontal speed of the wind in meters/second.
void	setVerticalWindSpeed(double value) Sets the vertical speed of the wind in meters/second.
void	setWindDirection(double value) Sets the direction the wind is coming from in radians, measured clockwise from North toward East.

Methods inherited from class agi.foundation.celestial.WindModel

checkForSameDefinition, enumerateDependencies, getCentralBody, getEvaluator, getRelativeVelocityVector, getWindVector, setCentralBody, validateProperties

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

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

ConstantWindModel

public ConstantWindModel()

Initializes a new instance with a default central body of Earth and no wind.

ConstantWindModel

public ConstantWindModel(double windDirection,
                         double horizontalWindSpeed,
                         double verticalWindSpeed)

Initializes a new instance with a default central body of Earth and the specified parameters.

Parameters:

windDirection - The direction the wind is coming from in radians, measured clockwise from North toward East.

horizontalWindSpeed - The horizontal speed of the wind in meters/second.

verticalWindSpeed - The vertical speed of the wind in meters/second.

ConstantWindModel

public ConstantWindModel(double windDirection,
                         double horizontalWindSpeed,
                         double verticalWindSpeed,
                         CentralBody centralBody)

Initializes a new instance with the specified parameters.

Parameters:

windDirection - The direction the wind is coming from in radians, measured clockwise from North toward East.

horizontalWindSpeed - The horizontal speed of the wind in meters/second.

verticalWindSpeed - The vertical speed of the wind in meters/second.

centralBody - The central body that the wind model is associated with.

ConstantWindModel

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

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final 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).

Specified by:

checkForSameDefinition in class WindModel

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(ConstantWindModel 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 ConstantWindModel.checkForSameDefinition(agi.foundation.celestial.WindModel) method.

Overrides:

computeCurrentDefinitionHashCode in class WindModel

Returns:

The computed hash code.

getWindDirection

public final double getWindDirection()

Gets the direction the wind is coming from in radians, measured clockwise from North toward East.

If the wind direction is from the northeast (PI / 4 radians), the wind vector will have negative components along the northerly and easterly directions.

setWindDirection

public final void setWindDirection(double value)

Sets the direction the wind is coming from in radians, measured clockwise from North toward East.

If the wind direction is from the northeast (PI / 4 radians), the wind vector will have negative components along the northerly and easterly directions.

getHorizontalWindSpeed

public final double getHorizontalWindSpeed()

Gets the horizontal speed of the wind in meters/second.

setHorizontalWindSpeed

public final void setHorizontalWindSpeed(double value)

Sets the horizontal speed of the wind in meters/second.

getVerticalWindSpeed

public final double getVerticalWindSpeed()

Gets the vertical speed of the wind in meters/second.

setVerticalWindSpeed

public final void setVerticalWindSpeed(double value)

Sets the vertical speed of the wind in meters/second.

getEvaluator

public VectorEvaluator getEvaluator(EvaluatorGroup group,
                                    IServiceProvider serviceProvider)

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

Specified by:

getEvaluator in class WindModel

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.

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