agi.foundation.communications

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

Class SignalComputation

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.SignalComputation

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public abstract class SignalComputation
extends DefinitionalObject

Base class for a signal computation, defined in terms of a SignalParameter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SignalComputation() Initializes a new instance.
protected	SignalComputation(SignalComputation existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	SignalComputation(SignalParameter parameter) Initializes a new 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(SignalComputation 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 IEvaluator1<Double>	getEvaluator(EvaluatorGroup group) Gets an evaluator that can be used to find the value of this computation for a given JulianDate.
SignalParameter	getParameter() Gets the signal parameter to use to parameterize this computation.
static SignalComputation	toSignalComputation(double value) Converts a constant double value to a SignalComputation.

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

SignalComputation

protected SignalComputation()

Initializes a new instance.

SignalComputation

protected SignalComputation(@Nonnull
                            SignalParameter parameter)

Initializes a new instance.

Parameters:

parameter - The signal parameter used to parameterize this computation.

SignalComputation

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

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getParameter

@Nonnull
public final SignalParameter getParameter()

Gets the signal parameter to use to parameterize this computation.

getEvaluator

@Nonnull
public abstract IEvaluator1<Double> getEvaluator(@Nonnull
                                                           EvaluatorGroup group)

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

Returns:

An evaluator for this computation.

toSignalComputation

@Nonnull
public static SignalComputation toSignalComputation(double value)

Converts a constant double value to a SignalComputation. The signal parameter will be ignored.

Parameters:

value - The value to convert.

Returns:

A new SignalComputation configured with the given constant value.