agi.foundation.geometry

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

Class VectorDependentOnServiceProvider

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.VectorDependentOnServiceProvider

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public abstract class VectorDependentOnServiceProvider
extends DefinitionalObject

A time-varying vector 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	VectorDependentOnServiceProvider() Initializes a new instance.
protected	VectorDependentOnServiceProvider(VectorDependentOnServiceProvider existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
Vector	applyServiceProvider(IServiceProvider serviceProvider) Gets a Vector that can be used to find the value of this vector 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(VectorDependentOnServiceProvider 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 VectorEvaluator	getEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider) Gets an evaluator that can be used to find the value of this vector function at a given JulianDate.
VectorEvaluator	getEvaluator(IServiceProvider serviceProvider) Gets an evaluator that can be used to find the value of this vector function at a given JulianDate.
static VectorDependentOnServiceProvider	toVectorDependentOnServiceProvider(Vector value) Creates a VectorDependentOnServiceProvider object wrapping a Vector value.

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

VectorDependentOnServiceProvider

protected VectorDependentOnServiceProvider()

Initializes a new instance.

VectorDependentOnServiceProvider

protected VectorDependentOnServiceProvider(@Nonnull
                                           VectorDependentOnServiceProvider 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(VectorDependentOnServiceProvider 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 VectorDependentOnServiceProvider.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getEvaluator

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

Gets an evaluator that can be used to find the value of this vector 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 vector function.

getEvaluator

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

Gets an evaluator that can be used to find the value of this vector 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 vector function.

applyServiceProvider

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

Gets a Vector that can be used to find the value of this vector 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 vector that will use the provided service provider.

Throws:

ArgumentNullException - Thrown when serviceProvider is null.

toVectorDependentOnServiceProvider

public static VectorDependentOnServiceProvider toVectorDependentOnServiceProvider(Vector value)

Creates a VectorDependentOnServiceProvider object wrapping a Vector value. The service provider parameter will be ignored when calculating the value.

Parameters:

value - The Vector value.

Returns:

A new VectorDependentOnServiceProvider object which will delegate to the given Vector value, ignoring the service provider parameter, or null if value is null.