public class IntendedReferenceSignal extends IntendedSignalStrategy
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.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.
|
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)
|
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)
|
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.
|
checkForSameDefinition, getIntendedSignalEvaluator
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
public IntendedReferenceSignal()
By default, the intended signal is BaseSignal
(get
) and the collection of unintended signals is empty.
public IntendedReferenceSignal(Signal referenceSignal, SignalCollection referenceUnintendedSignals)
referenceSignal
- The signal to use as the reference intended signal.referenceUnintendedSignals
- The collection of signals to use as a reference for the unintended signals.protected IntendedReferenceSignal(@Nonnull IntendedReferenceSignal existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext)
for more information about how to implement this constructor
in a derived class.
existingInstance
- The existing instance to copy.context
- A CopyContext
that controls the depth of the copy.ArgumentNullException
- Thrown when existingInstance
or context
is null
.public Object clone(CopyContext 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:
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:
CopyContext.updateReference(T)
. You should still call CopyContext.updateReference(T)
on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
as the last line in the constructor and pass it the
same CopyContext
passed to the constructor.
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;
clone
in interface ICloneWithContext
clone
in class DefinitionalObject
context
- The context to use to perform the copy.protected final boolean checkForSameDefinition(IntendedSignalStrategy other)
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)
.checkForSameDefinition
in class IntendedSignalStrategy
other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected boolean checkForSameDefinition(IntendedReferenceSignal other)
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)
.other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected int computeCurrentDefinitionHashCode()
IntendedReferenceSignal.checkForSameDefinition(agi.foundation.communications.signalprocessing.IntendedSignalStrategy)
method.computeCurrentDefinitionHashCode
in class IntendedSignalStrategy
public final Signal getReferenceSignal()
public final void setReferenceSignal(Signal value)
public final SignalCollection getReferenceUnintendedSignals()
IntendedReferenceSignal.getUnintendedSignalEvaluator(agi.foundation.EvaluatorGroup, agi.foundation.communications.SignalPropagationGraph, agi.foundation.communications.ISignalSource)
.public final void setReferenceUnintendedSignals(SignalCollection value)
IntendedReferenceSignal.getUnintendedSignalEvaluator(agi.foundation.EvaluatorGroup, agi.foundation.communications.SignalPropagationGraph, agi.foundation.communications.ISignalSource)
.public SignalEvaluator getAllIntendedSignalsEvaluator(EvaluatorGroup group, SignalPropagationGraph graph, ISignalSource signalSource)
getAllIntendedSignalsEvaluator
in class IntendedSignalStrategy
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.ArgumentNullException
- Thrown when group
is null
.PropertyInvalidException
- Thrown when ReferenceSignal
(get
/ set
) is null
.public SignalEvaluator getUnintendedSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph, ISignalSource signalSource)
ReferenceUnintendedSignals
(get
/ set
).
If ReferenceUnintendedSignals
(get
/ set
) is null
, the evaluator will always return an empty collection.
getUnintendedSignalEvaluator
in class IntendedSignalStrategy
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.ArgumentNullException
- Thrown when group
is null
.