TGainPattern
- The type of antenna gain pattern.TAntennaSignalProcessor
- The type of output antenna signal processor.public abstract class BaseDualPolarizedReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>> extends BaseReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor>
ObjectExtension
which represents a dual polarized receiving antenna.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.
|
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.
|
checkForSameDefinition, freezeAggregatedObjects, getAntennaGainPattern, getAntennaSignalProcessor, getCrossPolarizationLeakage, getOutputSignalProcessor, getOutputSignalProcessorPrepolarizer, getService, setAntennaGainPattern, setAntennaSignalProcessor, setCrossPolarizationLeakage
checkForSameDefinition, getOwner
areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getOwner
protected BaseDualPolarizedReceivingAntennaExtension(TGainPattern antennaGainPattern)
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
.protected BaseDualPolarizedReceivingAntennaExtension(@Nonnull BaseDualPolarizedReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor> 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
.protected final boolean checkForSameDefinition(BaseReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor> 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 BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>
other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected boolean checkForSameDefinition(BaseDualPolarizedReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor> 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()
BaseDualPolarizedReceivingAntennaExtension.checkForSameDefinition(agi.foundation.communications.antennas.BaseReceivingAntennaExtension<TGainPattern, TAntennaSignalProcessor>)
method.computeCurrentDefinitionHashCode
in class BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>
public void enumerateDependencies(DependencyEnumerator enumerator)
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.enumerateDependencies
in interface IEnumerateDependencies
enumerateDependencies
in class BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>
enumerator
- The enumerator that is informed of the dependencies of this object.public PolarizationSource getPolarizationSource()
getPolarizationSource
in class BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>
public void setPolarizationSource(PolarizationSource value)
setPolarizationSource
in class BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>
public final SignalProcessor getPrimaryPolarizationOutputSignalProcessor()
public final SignalProcessor getOrthogonalPolarizationOutputSignalProcessor()
protected final AntennaSignalProcessor<TGainPattern> getPrimaryPolarizationAntennaSignalProcessor()
protected final void setPrimaryPolarizationAntennaSignalProcessor(AntennaSignalProcessor<TGainPattern> value)
protected final AntennaSignalProcessor<TGainPattern> getOrthogonalPolarizationAntennaSignalProcessor()
protected final void setOrthogonalPolarizationAntennaSignalProcessor(AntennaSignalProcessor<TGainPattern> value)