agi.foundation.communications.signalprocessing

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

Class IntendedReferenceSignal

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.IntendedSignalStrategy

agi.foundation.communications.signalprocessing.IntendedReferenceSignal

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class IntendedReferenceSignal
extends IntendedSignalStrategy

An IntendedSignalStrategy which simply returns a specified reference signal. This is useful to compare numbers against a simplified reference signal. For example, you could compare the result of ScalarReceivedIsotropicPower from a link budget to the corresponding scalar value produced from a given reference signal without applying any propagation or signal processing effects.

Constructor Summary

Constructors

Modifier	Constructor and Description
	IntendedReferenceSignal() Initialize a new instance.
protected	IntendedReferenceSignal(IntendedReferenceSignal existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	IntendedReferenceSignal(Signal referenceSignal, SignalCollection referenceUnintendedSignals) Initialize a new instance based on the given reference intended and unintended signals.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(IntendedReferenceSignal other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(IntendedSignalStrategy other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
SignalEvaluator	getAllIntendedSignalsEvaluator(EvaluatorGroup group, SignalPropagationGraph graph, ISignalSource signalSource) Get an evaluator which simply produces the ReferenceSignal (get / set).
Signal	getReferenceSignal() Gets the reference signal which is produced as the intended signal.
SignalCollection	getReferenceUnintendedSignals() Gets the collection of signals which represent the unintended signals (e.g.
SignalEvaluator	getUnintendedSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph, ISignalSource signalSource) Get an evaluator which simply produces the ReferenceUnintendedSignals (get / set).
void	setReferenceSignal(Signal value) Sets the reference signal which is produced as the intended signal.
void	setReferenceUnintendedSignals(SignalCollection value) Sets the collection of signals which represent the unintended signals (e.g.

Methods inherited from class agi.foundation.communications.signalprocessing.IntendedSignalStrategy

checkForSameDefinition, getIntendedSignalEvaluator

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, 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

IntendedReferenceSignal

public IntendedReferenceSignal()

Initialize a new instance.

By default, the intended signal is BaseSignal (get) and the collection of unintended signals is empty.

IntendedReferenceSignal

public IntendedReferenceSignal(Signal referenceSignal,
                               SignalCollection referenceUnintendedSignals)

Initialize a new instance based on the given reference intended and unintended signals.

Parameters:

referenceSignal - The signal to use as the reference intended signal.

referenceUnintendedSignals - The collection of signals to use as a reference for the unintended signals.

IntendedReferenceSignal

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

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final 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).

Specified by:

checkForSameDefinition in class IntendedSignalStrategy

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(IntendedReferenceSignal 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 IntendedReferenceSignal.checkForSameDefinition(agi.foundation.communications.signalprocessing.IntendedSignalStrategy) method.

Overrides:

computeCurrentDefinitionHashCode in class IntendedSignalStrategy

Returns:

The computed hash code.

getReferenceSignal

public final Signal getReferenceSignal()

Gets the reference signal which is produced as the intended signal.

setReferenceSignal

public final void setReferenceSignal(Signal value)

Sets the reference signal which is produced as the intended signal.

getReferenceUnintendedSignals

public final SignalCollection getReferenceUnintendedSignals()

Gets the collection of signals which represent the unintended signals (e.g. interference) produced by IntendedReferenceSignal.getUnintendedSignalEvaluator(agi.foundation.EvaluatorGroup, agi.foundation.communications.SignalPropagationGraph, agi.foundation.communications.ISignalSource).

setReferenceUnintendedSignals

public final void setReferenceUnintendedSignals(SignalCollection value)

Sets the collection of signals which represent the unintended signals (e.g. interference) produced by IntendedReferenceSignal.getUnintendedSignalEvaluator(agi.foundation.EvaluatorGroup, agi.foundation.communications.SignalPropagationGraph, agi.foundation.communications.ISignalSource).

getAllIntendedSignalsEvaluator

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

Get an evaluator which simply produces the ReferenceSignal (get / set).

Specified by:

getAllIntendedSignalsEvaluator in class IntendedSignalStrategy

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 reference signal.

Throws:

ArgumentNullException - Thrown when group is null.

PropertyInvalidException - Thrown when ReferenceSignal (get / set) is null.

getUnintendedSignalEvaluator

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

Get an evaluator which simply produces the ReferenceUnintendedSignals (get / set).

If ReferenceUnintendedSignals (get / set) is null, the evaluator will always return an empty collection.

Overrides:

getUnintendedSignalEvaluator in class IntendedSignalStrategy

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 unintended or interfering signals.

Throws:

ArgumentNullException - Thrown when group is null.