agi.foundation.communications.antennas

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

Class WeightedLinkExtension

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.infrastructure.ObjectExtension

agi.foundation.communications.antennas.WeightedLinkExtension

All Implemented Interfaces:

ILinkWeightService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

ScalarWeightLinkExtension

public abstract class WeightedLinkExtension
extends ObjectExtension
implements ILinkWeightService

An ObjectExtension which provides the ILinkWeightService for associating a computational weight to a link.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WeightedLinkExtension() Initializes a new instance.
protected	WeightedLinkExtension(WeightedLinkExtension 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(ObjectExtension other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(WeightedLinkExtension 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	getLinkWeightEvaluator(EvaluatorGroup group) Gets a ScalarEvaluator for evaluating the computational weight.

Methods inherited from class agi.foundation.infrastructure.ObjectExtension

checkForSameDefinition, enumerateDependencies, getOwner, getService

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

WeightedLinkExtension

protected WeightedLinkExtension()

Initializes a new instance.

WeightedLinkExtension

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

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

Overrides:

computeCurrentDefinitionHashCode in class ObjectExtension

Returns:

The computed hash code.

getLinkWeightEvaluator

public abstract ScalarEvaluator getLinkWeightEvaluator(EvaluatorGroup group)

Gets a ScalarEvaluator for evaluating the computational weight.

Specified by:

getLinkWeightEvaluator in interface ILinkWeightService

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.

Returns:

An evaluator used to evaluate link computational weight.