agi.foundation.geometry

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

Class ScalarDependentOnServiceProvider

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.ScalarDependentOnServiceProvider

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

RefractiveIndexStructureParameterModel, ScalarDynamicPressure, ScalarEquivalentAirspeed, ScalarMachNumber

public abstract class ScalarDependentOnServiceProvider
extends DefinitionalObject

A scalar, representing a real valued, time varying function which depends on one or more services from an IServiceProvider in order to get an evaluator. The specific required service or services will be documented by the class which requires an instance of this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Scalar	applyServiceProvider(IServiceProvider serviceProvider) Gets a Scalar that can be used to find the value of this scalar function at a given JulianDate.
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(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.
abstract ScalarEvaluator	getEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider) Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.
ScalarEvaluator	getEvaluator(IServiceProvider serviceProvider) Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.
static ScalarDependentOnServiceProvider	toScalarDependentOnServiceProvider(double value) Converts a constant double value to a ScalarDependentOnServiceProvider.
static ScalarDependentOnServiceProvider	toScalarDependentOnServiceProvider(Scalar value) Converts a Scalar to a ScalarDependentOnServiceProvider.

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

ScalarDependentOnServiceProvider

protected ScalarDependentOnServiceProvider()

Initializes a new instance.

ScalarDependentOnServiceProvider

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

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

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getEvaluator

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

Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.

Parameters:

serviceProvider - The service provider to use when calculating the value. The specific service or services that this service provider must provide can vary depending on the derived class implementation.

Returns:

An evaluator for this scalar function.

Throws:

ArgumentNullException - Thrown when serviceProvider is null.

getEvaluator

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

Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate. Adds the evaluator to the given 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.

serviceProvider - The service provider to use when calculating the value. The specific service or services that this service provider must provide can vary depending on the derived class implementation.

Returns:

An evaluator for this scalar function.

Throws:

ArgumentNullException - Thrown when group or serviceProvider is null.

applyServiceProvider

@Nonnull
public final Scalar applyServiceProvider(@Nonnull
                                                   IServiceProvider serviceProvider)

Gets a Scalar that can be used to find the value of this scalar function at a given JulianDate.

Parameters:

serviceProvider - The service provider to use when calculating the value. The specific service or services that this service provider must provide can vary depending on the derived class implementation.

Returns:

A scalar that will use the provided service provider.

Throws:

ArgumentNullException - Thrown when serviceProvider is null.

toScalarDependentOnServiceProvider

public static ScalarDependentOnServiceProvider toScalarDependentOnServiceProvider(Scalar value)

Converts a Scalar to a ScalarDependentOnServiceProvider. The service provider parameter will be ignored when calculating the value.

Parameters:

value - The value to convert.

Returns:

A new ScalarDependentOnServiceProvider which will delegate to the given Scalar value, ignoring the service provider parameter, or null if value is null.

toScalarDependentOnServiceProvider

@Nonnull
public static ScalarDependentOnServiceProvider toScalarDependentOnServiceProvider(double value)

Converts a constant double value to a ScalarDependentOnServiceProvider. The service provider parameter will be ignored when calculating the value.

Parameters:

value - The value to convert.

Returns:

A new ScalarDependentOnServiceProvider representing the constant double value.