agi.foundation.communications.antennas

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

Class AntennaSignalProcessor<TGainPattern extends BaseGainPattern>

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.SignalProcessor

agi.foundation.communications.antennas.AntennaSignalProcessor<TGainPattern>

Type Parameters:

TGainPattern - The type of antenna gain pattern.

All Implemented Interfaces:

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

Direct Known Subclasses:

OpticalAntennaSignalProcessor, RadarAntennaSignalProcessor, RadioFrequencyAntennaSignalProcessor

public abstract class AntennaSignalProcessor<TGainPattern extends BaseGainPattern>
extends SignalProcessor
implements ISignalReceivedByAntennaPrepolarizerService

Abstract base class for all antenna signal processors. Used to model the output signals of a receiving antenna.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AntennaSignalProcessor(AntennaSignalProcessor<TGainPattern> existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	AntennaSignalProcessor(IReceivingAntennaExtension<TGainPattern> receivingAntennaExtension, double minimumFrequency, double maximumFrequency) Initializes a new instance with a given minimum frequency, maximum frequency, and antenna gain pattern.
protected	AntennaSignalProcessor(IReceivingAntennaExtension<TGainPattern> receivingAntennaExtension, double minimumFrequency, double maximumFrequency, PolarizationSource polarizationSource) Initializes a new instance with a given minimum frequency, maximum frequency, antenna gain pattern, and polarization source.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(AntennaSignalProcessor<TGainPattern> other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected 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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
double	getCrossPolarizationLeakage() Gets the cross polarization leakage value.
SignalProcessor	getInputSignalProcessor() Gets the input to the signal processor.
double	getMaximumFrequency() Gets the maximum frequency.
double	getMinimumFrequency() Gets the minimum frequency.
ISignalSource	getOutputSignalProcessorPrepolarizer() Gets a signal evaluator which produces signals which have the antenna gain applied but not the polarization efficiency.
PolarizationSource	getPolarizationSource() Gets the polarization source.
IReceivingAntennaExtension<TGainPattern>	getReceivingAntennaExtension() Gets the receiving antenna extension instance used to retrieve the links associated with this antenna from the SignalPropagationGraph parameter passed to the AntennaSignalProcessor.getSignalEvaluator(agi.foundation.EvaluatorGroup, agi.foundation.communications.SignalPropagationGraph) method.
SignalEvaluator	getSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph) Get an evaluator which can produce the output from the signal processor.
protected SignalEvaluator	getSignalEvaluatorForLink(EvaluatorGroup group, SignalPropagationGraph graph, IServiceProvider link) Gets the signal evaluator for the supplied link.
void	setCrossPolarizationLeakage(double value) Sets the cross polarization leakage value.
void	setInputSignalProcessor(SignalProcessor value) Sets the input to the signal processor.
void	setMaximumFrequency(double value) Sets the maximum frequency.
void	setMinimumFrequency(double value) Sets the minimum frequency.
void	setPolarizationSource(PolarizationSource value) Sets the polarization source.

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

checkForSameDefinition, getProcessingDelay, getService, getSignalEvaluator, getSignalOutput

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, 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

AntennaSignalProcessor

protected AntennaSignalProcessor(IReceivingAntennaExtension<TGainPattern> receivingAntennaExtension,
                                 double minimumFrequency,
                                 double maximumFrequency)

Initializes a new instance with a given minimum frequency, maximum frequency, and antenna gain pattern.

Parameters:

minimumFrequency - The minimum frequency. All received signals with frequency bands which fall entirely below this frequency will be rejected and will not show up in the output signal collection.

maximumFrequency - The maximum frequency. All received signals with frequency bands which fall entirely above this frequency will be rejected and will not show up in the output signal collection.

receivingAntennaExtension - The receiving antenna extension.

AntennaSignalProcessor

protected AntennaSignalProcessor(IReceivingAntennaExtension<TGainPattern> receivingAntennaExtension,
                                 double minimumFrequency,
                                 double maximumFrequency,
                                 PolarizationSource polarizationSource)

Initializes a new instance with a given minimum frequency, maximum frequency, antenna gain pattern, and polarization source.

Parameters:

minimumFrequency - The minimum frequency. All received signals with frequency bands which fall entirely below this frequency will be rejected and will not show up in the output signal collection.

maximumFrequency - The maximum frequency. All received signals with frequency bands which fall entirely above this frequency will be rejected and will not show up in the output signal collection.

receivingAntennaExtension - The receiving antenna extension.

polarizationSource - The polarization source for modeling polarization efficiency.

AntennaSignalProcessor

protected AntennaSignalProcessor(@Nonnull
                                 AntennaSignalProcessor<TGainPattern> 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(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).

Specified by:

checkForSameDefinition in class SignalProcessor

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(AntennaSignalProcessor<TGainPattern> 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 AntennaSignalProcessor.checkForSameDefinition(agi.foundation.communications.signalprocessing.SignalProcessor) method.

Overrides:

computeCurrentDefinitionHashCode in class SignalProcessor

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getInputSignalProcessor

public SignalProcessor getInputSignalProcessor()

Gets the input to the signal processor.

Since this signal processor obtains its signals from the SignalPropagationGraph and not from an input signal processor, this property will always return null, and will throw IllegalStateException when set.

Specified by:

getInputSignalProcessor in class SignalProcessor

setInputSignalProcessor

public void setInputSignalProcessor(SignalProcessor value)

Sets the input to the signal processor.

Since this signal processor obtains its signals from the SignalPropagationGraph and not from an input signal processor, this property will always return null, and will throw IllegalStateException when set.

Specified by:

setInputSignalProcessor in class SignalProcessor

getOutputSignalProcessorPrepolarizer

public final ISignalSource getOutputSignalProcessorPrepolarizer()

Gets a signal evaluator which produces signals which have the antenna gain applied but not the polarization efficiency.

Specified by:

getOutputSignalProcessorPrepolarizer in interface ISignalReceivedByAntennaPrepolarizerService

Returns:

An ISignalSource which represents the received signals before polarization efficiency is applied.

getSignalEvaluator

public SignalEvaluator getSignalEvaluator(EvaluatorGroup group,
                                          SignalPropagationGraph graph)

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

Specified by:

getSignalEvaluator in interface ISignalSource

Specified by:

getSignalEvaluator in class SignalProcessor

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.

getSignalEvaluatorForLink

@Nonnull
protected final SignalEvaluator getSignalEvaluatorForLink(@Nonnull
                                                                    EvaluatorGroup group,
                                                                    @Nonnull
                                                                    SignalPropagationGraph graph,
                                                                    @Nonnull
                                                                    IServiceProvider link)

Gets the signal evaluator for the supplied link.

Parameters:

group - The evaluator group to use when creating evaluators.

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

link - The link for which to get the signal evaluator.

Returns:

The signal evaluator for evaluating the link signals.

getMinimumFrequency

public final double getMinimumFrequency()

Gets the minimum frequency. All received signals with frequency bands which fall entirely below this frequency will be rejected and will not show up in the output signal collection.

setMinimumFrequency

public final void setMinimumFrequency(double value)

Sets the minimum frequency. All received signals with frequency bands which fall entirely below this frequency will be rejected and will not show up in the output signal collection.

getMaximumFrequency

public final double getMaximumFrequency()

Gets the maximum frequency. All received signals with frequency bands which fall entirely above this frequency will be rejected and will not show up in the output signal collection.

setMaximumFrequency

public final void setMaximumFrequency(double value)

Sets the maximum frequency. All received signals with frequency bands which fall entirely above this frequency will be rejected and will not show up in the output signal collection.

getPolarizationSource

public final PolarizationSource getPolarizationSource()

Gets the polarization source.

setPolarizationSource

public final void setPolarizationSource(PolarizationSource value)

Sets the polarization source.

getCrossPolarizationLeakage

public final double getCrossPolarizationLeakage()

Gets the cross polarization leakage value.

The cross polarization leakage is the minimum polarization efficiency possible, for example if the source polarization is left hand circular and the receive polarization is right hand polarization. Theoretically this efficiency in this case would be 0.0, but in practice a small amount of energy will leak through from the left hand to right hand. This value represents that leakage.

setCrossPolarizationLeakage

public final void setCrossPolarizationLeakage(double value)

Sets the cross polarization leakage value.

The cross polarization leakage is the minimum polarization efficiency possible, for example if the source polarization is left hand circular and the receive polarization is right hand polarization. Theoretically this efficiency in this case would be 0.0, but in practice a small amount of energy will leak through from the left hand to right hand. This value represents that leakage.

getReceivingAntennaExtension

public final IReceivingAntennaExtension<TGainPattern> getReceivingAntennaExtension()

Gets the receiving antenna extension instance used to retrieve the links associated with this antenna from the SignalPropagationGraph parameter passed to the AntennaSignalProcessor.getSignalEvaluator(agi.foundation.EvaluatorGroup, agi.foundation.communications.SignalPropagationGraph) method.