agi.foundation.communications.signalprocessing

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

Class IntendedSignalStrategy

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.IntendedSignalStrategy

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

CompositeIntendedSignalStrategy, IntendedReferenceSignal, IntendedSignalByDataType, IntendedSignalByFrequency, IntendedSignalByIdentifier, IntendedSignalByModulation, IntendedSignalByTransmitter

public abstract class IntendedSignalStrategy
extends DefinitionalObject

A class which defines a strategy for locating one Signal, or all Signals, designated as "intended" from the set of Signals from a given ISignalSource. The remaining signals are designated as "unintended" signals.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IntendedSignalStrategy() Initializes a new instance.
protected	IntendedSignalStrategy(IntendedSignalStrategy 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(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(IntendedSignalStrategy 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 SignalEvaluator	getAllIntendedSignalsEvaluator(EvaluatorGroup group, SignalPropagationGraph graph, ISignalSource signalSource) Gets a signal evaluator which when evaluated will return all of the intended signals from a collection of signals.
Evaluator<Signal>	getIntendedSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph, ISignalSource signalSource) Get an evaluator which produces a single Signal as the intended signal from the given ISignalSource.
SignalEvaluator	getUnintendedSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph, ISignalSource signalSource) Get an evaluator which produces a collection of Signals from the given ISignalSource by determining the intended signal and removing it from the collection.

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

IntendedSignalStrategy

protected IntendedSignalStrategy()

Initializes a new instance.

IntendedSignalStrategy

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

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getIntendedSignalEvaluator

@Nonnull
public Evaluator<Signal> getIntendedSignalEvaluator(@Nonnull
                                                              EvaluatorGroup group,
                                                              @Nonnull
                                                              SignalPropagationGraph graph,
                                                              @Nonnull
                                                              ISignalSource signalSource)

Get an evaluator which produces a single Signal as the intended signal from the given ISignalSource.

Parameters:

group - The evaluator group to use when creating evaluators.

graph - The graph of the communication links used to propagate signals.

signalSource - The source of the input signals.

Returns:

An evaluator which produces the intended signal.

Throws:

ArgumentNullException - Thrown when group, graph, or signalSource is null.

getAllIntendedSignalsEvaluator

@Nonnull
public abstract SignalEvaluator getAllIntendedSignalsEvaluator(@Nonnull
                                                                         EvaluatorGroup group,
                                                                         @Nonnull
                                                                         SignalPropagationGraph graph,
                                                                         @Nonnull
                                                                         ISignalSource signalSource)

Gets a signal evaluator which when evaluated will return all of the intended signals from a collection of signals. If there are no matching signals, the evaluator will return an empty SignalCollection.

Parameters:

group - The evaluator group to use when creating evaluators.

graph - The graph of the communication links used to propagate signals.

signalSource - The source of the input signals.

Returns:

The signal evaluator for evaluating the intended signals.

Throws:

ArgumentNullException - Thrown when group, graph, or signalSource is null.

getUnintendedSignalEvaluator

@Nonnull
public SignalEvaluator getUnintendedSignalEvaluator(@Nonnull
                                                              EvaluatorGroup group,
                                                              @Nonnull
                                                              SignalPropagationGraph graph,
                                                              @Nonnull
                                                              ISignalSource signalSource)

Get an evaluator which produces a collection of Signals from the given ISignalSource by determining the intended signal and removing it from the collection.

Parameters:

group - The evaluator group to use when creating evaluators.

graph - The graph of the communication links used to propagate signals.

signalSource - The source of the input signals.

Returns:

An evaluator which produces the set of signals not including the intended signal.

Throws:

ArgumentNullException - Thrown when group, graph, or signalSource is null.