agi.foundation.communications.signalprocessing

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

Class FilteredSignalSource

java.lang.Object

agi.foundation.communications.signalprocessing.FilteredSignalSource

All Implemented Interfaces:

ISignalSource, ICloneWithContext

public class FilteredSignalSource
extends Object
implements ISignalSource, ICloneWithContext

Filters out any signal which does not overlap the desired band. Used to reject optical signals from an RF receiver or RF signals from an optical receiver. Not intended to perform bandwidth overlap computations.

Constructor Summary

Constructors

Modifier	Constructor and Description
	FilteredSignalSource() Initializes a new instance.
protected	FilteredSignalSource(FilteredSignalSource existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	FilteredSignalSource(ISignalSource inputSignalSource, double minimumFrequency, double maximumFrequency) Initialize a new instance.

Method Summary

Modifier and Type	Method and Description
Object	clone(CopyContext context) Clones this object using the specified context.
ISignalSource	getInputSignalSource() Gets the input ISignalSource.
double	getMaximumFrequency() Gets the filter's maximum frequency.
double	getMinimumFrequency() Gets the filter's minimum frequency.
SignalEvaluator	getSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph) Gets a SignalEvaluator which will filter out signals from the input source which do not have a frequency which falls between the minimum and maximum frequencies of the filter.
void	setInputSignalSource(ISignalSource value) Sets the input ISignalSource.
void	setMaximumFrequency(double value) Sets the filter's maximum frequency.
void	setMinimumFrequency(double value) Sets the filter's minimum frequency.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilteredSignalSource

public FilteredSignalSource()

Initializes a new instance.

FilteredSignalSource

public FilteredSignalSource(ISignalSource inputSignalSource,
                            double minimumFrequency,
                            double maximumFrequency)

Initialize a new instance.

Parameters:

inputSignalSource - The ISignalSource used to obtain the input signals.

minimumFrequency - The minimum signal frequency allowed by the filter.

maximumFrequency - The maximum signal frequency allowed by the filter.

FilteredSignalSource

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

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

getInputSignalSource

public final ISignalSource getInputSignalSource()

Gets the input ISignalSource.

setInputSignalSource

public final void setInputSignalSource(ISignalSource value)

Sets the input ISignalSource.

getMinimumFrequency

public final double getMinimumFrequency()

Gets the filter's minimum frequency.

setMinimumFrequency

public final void setMinimumFrequency(double value)

Sets the filter's minimum frequency.

getMaximumFrequency

public final double getMaximumFrequency()

Gets the filter's maximum frequency.

setMaximumFrequency

public final void setMaximumFrequency(double value)

Sets the filter's maximum frequency.

getSignalEvaluator

public final SignalEvaluator getSignalEvaluator(EvaluatorGroup group,
                                                SignalPropagationGraph graph)

Gets a SignalEvaluator which will filter out signals from the input source which do not have a frequency which falls between the minimum and maximum frequencies of the filter.

Specified by:

getSignalEvaluator in interface ISignalSource

Parameters:

group - The evaluator group in which to create the evaluator.

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

Returns:

The SignalEvaluator which will perform the filtering operation on the input signal source.

Throws:

ArgumentNullException - Thrown if either group or graph are null

PropertyInvalidException - Thrown if InputSignalSource (get / set) is null, or if either MinimumFrequency (get / set) or MaximumFrequency (get / set) is less than or equal to 0.0 Hz, or if MaximumFrequency (get / set) is less than MinimumFrequency (get / set).