agi.foundation.communications.signalprocessing

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

Class SignalProcessor

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.SignalProcessor

All Implemented Interfaces:

ISignalSource, ISignalOutputService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

Amplifier, AntennaSignalProcessor, ConstantFrequencyMixer, DigitalDataSource, DigitalDemodulator, DigitalModulator, OrthogonalPolarizationChannelSource, Photodetector, PrimaryPolarizationChannelSource, PulsedSignalModulator, SignalFilter, SignalSource, VariableFrequencyMixer

public abstract class SignalProcessor
extends DefinitionalObject
implements ISignalSource, IServiceProvider, ISignalOutputService

Base class for all signal processors containing an input and an output.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SignalProcessor() Initializes a new instance.
protected	SignalProcessor(SignalProcessor 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(SignalProcessor 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 SignalProcessor	getInputSignalProcessor() Gets the input to the signal processor.
Evaluator<Duration>	getProcessingDelay(EvaluatorGroup group, SignalPropagationGraph graph) Get an evaluator which computes the time delay between the input and output of this signal processor.
Object	getService(Class<?> serviceType) Gets the service object of the specified type.
abstract SignalEvaluator	getSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph) Get an evaluator which can produce the output from the signal processor.
SignalEvaluator	getSignalEvaluator(SignalPropagationGraph graph) Get an evaluator which can produce the output from the signal processor.
SignalProcessor	getSignalOutput() Gets the signal processor representing the output of the service provider.
abstract void	setInputSignalProcessor(SignalProcessor value) Sets the input to the signal processor.

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

SignalProcessor

protected SignalProcessor()

Initializes a new instance.

SignalProcessor

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

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getInputSignalProcessor

public abstract SignalProcessor getInputSignalProcessor()

Gets the input to the signal processor.

setInputSignalProcessor

public abstract void setInputSignalProcessor(SignalProcessor value)

Sets the input to the signal processor.

getService

@Nullable
public Object getService(@Nonnull
                                    Class<?> serviceType)

Gets the service object of the specified type.

Specified by:

getService in interface IServiceProvider

Parameters:

serviceType - An object that specifies the type of service object to get.

Returns:

The found service, or null if the service does not exist.

Throws:

ArgumentNullException - Thrown when serviceType is null.

getSignalOutput

public final SignalProcessor getSignalOutput()

Gets the signal processor representing the output of the service provider.

Specified by:

getSignalOutput in interface ISignalOutputService

getProcessingDelay

@Nonnull
public Evaluator<Duration> getProcessingDelay(@Nonnull
                                                        EvaluatorGroup group,
                                                        SignalPropagationGraph graph)

Get an evaluator which computes the time delay between the input and output of this signal processor.

Parameters:

group - An evaluator group in which to create dependent evaluators

graph - The configuration of the communication link graph.

Returns:

An evaluator which computes the time delay of this signal processor.

getSignalEvaluator

@Nonnull
public final SignalEvaluator getSignalEvaluator(SignalPropagationGraph graph)

Get an evaluator which can produce the output from the signal processor.

Parameters:

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

Returns:

An evaluator which produces the output signal from this signal processor.

getSignalEvaluator

public abstract SignalEvaluator getSignalEvaluator(EvaluatorGroup group,
                                                   SignalPropagationGraph graph)

Get an evaluator which can produce the output from the signal processor.

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:

An evaluator which produces the output signal from this signal processor.

Throws:

ArgumentNullException - Thrown when group or graph is null.