agi.foundation.communications.antennas

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

Class BaseDualPolarizedReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.infrastructure.ObjectExtension

agi.foundation.communications.antennas.BaseReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor>

agi.foundation.communications.antennas.BaseDualPolarizedReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor>

Type Parameters:

TGainPattern - The type of antenna gain pattern.

TAntennaSignalProcessor - The type of output antenna signal processor.

All Implemented Interfaces:

IReceivingAntennaExtension<TGainPattern>, ISignalReceivedByAntennaPrepolarizerService, ISignalReceivedByAntennaService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

DualPolarizedRadarReceivingAntennaExtension, DualPolarizedRadioFrequencyReceivingAntennaExtension

public abstract class BaseDualPolarizedReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>
extends BaseReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor>

An ObjectExtension which represents a dual polarized receiving antenna.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseDualPolarizedReceivingAntennaExtension(BaseDualPolarizedReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor> existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	BaseDualPolarizedReceivingAntennaExtension(TGainPattern antennaGainPattern) Initializes a new instance with a given antenna gain pattern.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(BaseDualPolarizedReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor> other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(BaseReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor> 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.
protected AntennaSignalProcessor<TGainPattern>	getOrthogonalPolarizationAntennaSignalProcessor() Gets the antenna signal processor which produces the antenna's orthogonal polarization channel signal output.
SignalProcessor	getOrthogonalPolarizationOutputSignalProcessor() Gets the antenna signal processor which produces the antenna's orthogonal polarization channel signal output.
PolarizationSource	getPolarizationSource() Gets the polarization source for the primary polarization channel.
protected AntennaSignalProcessor<TGainPattern>	getPrimaryPolarizationAntennaSignalProcessor() Gets the antenna signal processor which produces the antenna's primary polarization channel signal output.
SignalProcessor	getPrimaryPolarizationOutputSignalProcessor() Gets the antenna signal processor which produces the antenna's primary polarization channel signal output.
protected void	setOrthogonalPolarizationAntennaSignalProcessor(AntennaSignalProcessor<TGainPattern> value) Sets the antenna signal processor which produces the antenna's orthogonal polarization channel signal output.
void	setPolarizationSource(PolarizationSource value) Sets the polarization source for the primary polarization channel.
protected void	setPrimaryPolarizationAntennaSignalProcessor(AntennaSignalProcessor<TGainPattern> value) Sets the antenna signal processor which produces the antenna's primary polarization channel signal output.

Methods inherited from class agi.foundation.communications.antennas.BaseReceivingAntennaExtension

checkForSameDefinition, freezeAggregatedObjects, getAntennaGainPattern, getAntennaSignalProcessor, getCrossPolarizationLeakage, getOutputSignalProcessor, getOutputSignalProcessorPrepolarizer, getService, setAntennaGainPattern, setAntennaSignalProcessor, setCrossPolarizationLeakage

Methods inherited from class agi.foundation.infrastructure.ObjectExtension

checkForSameDefinition, getOwner

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

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

Methods inherited from interface agi.foundation.communications.antennas.IReceivingAntennaExtension

getOwner

Constructor Detail

BaseDualPolarizedReceivingAntennaExtension

protected BaseDualPolarizedReceivingAntennaExtension(TGainPattern antennaGainPattern)

Initializes a new instance with a given antenna gain pattern.

Parameters:

antennaGainPattern - The gain pattern to apply to incoming signals based on the angle off of the boresight (z-axis) of the parent object's Axes.

BaseDualPolarizedReceivingAntennaExtension

protected BaseDualPolarizedReceivingAntennaExtension(@Nonnull
                                                     BaseDualPolarizedReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor> 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(BaseReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor> 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 BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>

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(BaseDualPolarizedReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor> 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 BaseDualPolarizedReceivingAntennaExtension.checkForSameDefinition(agi.foundation.communications.antennas.BaseReceivingAntennaExtension<TGainPattern, TAntennaSignalProcessor>) method.

Overrides:

computeCurrentDefinitionHashCode in class BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>

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 BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>

Parameters:

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

getPolarizationSource

public PolarizationSource getPolarizationSource()

Gets the polarization source for the primary polarization channel. The orthogonal version of the polarization produced by this source will be used for the orthogonal channel.

Overrides:

getPolarizationSource in class BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>

setPolarizationSource

public void setPolarizationSource(PolarizationSource value)

Sets the polarization source for the primary polarization channel. The orthogonal version of the polarization produced by this source will be used for the orthogonal channel.

Overrides:

setPolarizationSource in class BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>

getPrimaryPolarizationOutputSignalProcessor

public final SignalProcessor getPrimaryPolarizationOutputSignalProcessor()

Gets the antenna signal processor which produces the antenna's primary polarization channel signal output.

getOrthogonalPolarizationOutputSignalProcessor

public final SignalProcessor getOrthogonalPolarizationOutputSignalProcessor()

Gets the antenna signal processor which produces the antenna's orthogonal polarization channel signal output.

getPrimaryPolarizationAntennaSignalProcessor

protected final AntennaSignalProcessor<TGainPattern> getPrimaryPolarizationAntennaSignalProcessor()

Gets the antenna signal processor which produces the antenna's primary polarization channel signal output.

setPrimaryPolarizationAntennaSignalProcessor

protected final void setPrimaryPolarizationAntennaSignalProcessor(AntennaSignalProcessor<TGainPattern> value)

Sets the antenna signal processor which produces the antenna's primary polarization channel signal output.

getOrthogonalPolarizationAntennaSignalProcessor

protected final AntennaSignalProcessor<TGainPattern> getOrthogonalPolarizationAntennaSignalProcessor()

Gets the antenna signal processor which produces the antenna's orthogonal polarization channel signal output.

setOrthogonalPolarizationAntennaSignalProcessor

protected final void setOrthogonalPolarizationAntennaSignalProcessor(AntennaSignalProcessor<TGainPattern> value)

Sets the antenna signal processor which produces the antenna's orthogonal polarization channel signal output.