agi.foundation.communications.antennas

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

Class BaseReceivingAntennaExtension<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>

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:

BaseDualPolarizedReceivingAntennaExtension, OpticalReceivingAntennaExtension, RadarReceivingAntennaExtension, RadioFrequencyReceivingAntennaExtension

public abstract class BaseReceivingAntennaExtension<TGainPattern extends BaseGainPattern,TAntennaSignalProcessor extends AntennaSignalProcessor<TGainPattern>>
extends ObjectExtension
implements IReceivingAntennaExtension<TGainPattern>

An extension which searches the SignalPropagationGraph for all incoming signals entering its Owner (get / set) and processes them with a receiving BaseGainPattern before passing them to its OutputSignalProcessor (get) signal processor. Constraints added as extensions to link objects are taken into account when determining which links produce signals for the receiver.

If an incoming link has the IAccessResultService, it will only be evaluated during the SatisfactionIntervals (get) and will throw an IllegalStateException during the UnknownIntervals (get). Otherwise, if an incoming link has the IAccessConstraintsService, it will only produce signals at times when it has access. All the constraints provided by the service will be combined in an AccessQueryAnd except for any CommunicationObjectConstraints which should never be added to a link. In this case, an IllegalStateException is thrown. Since a CommunicationObjectConstraint usually involves evaluating the link when attempting to evaluate an object which occurs after the link, this would produce an infinite loop and is not allowed.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseReceivingAntennaExtension(BaseReceivingAntennaExtension<TGainPattern,TAntennaSignalProcessor> existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	BaseReceivingAntennaExtension(TGainPattern gainPattern) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected abstract 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 boolean	checkForSameDefinition(ObjectExtension 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 void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
TGainPattern	getAntennaGainPattern() Gets the gain pattern for this antenna.
protected AntennaSignalProcessor<TGainPattern>	getAntennaSignalProcessor() Gets the antenna signal processor which produces the antenna's signal output.
double	getCrossPolarizationLeakage() Gets the cross polarization leakage value.
SignalProcessor	getOutputSignalProcessor() Gets the SignalProcessor which produces the antenna's signal output.
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.
Object	getService(Class<?> serviceType) Gets the service object of the specified type.
void	setAntennaGainPattern(TGainPattern value) Sets the gain pattern for this antenna.
protected void	setAntennaSignalProcessor(AntennaSignalProcessor<TGainPattern> value) Sets the antenna signal processor which produces the antenna's signal output.
void	setCrossPolarizationLeakage(double value) Sets the cross polarization leakage value.
void	setPolarizationSource(PolarizationSource value) Sets the polarization source.

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

BaseReceivingAntennaExtension

protected BaseReceivingAntennaExtension(TGainPattern gainPattern)

Initializes a new instance.

Parameters:

gainPattern - The gain pattern for this antenna.

BaseReceivingAntennaExtension

protected BaseReceivingAntennaExtension(@Nonnull
                                        BaseReceivingAntennaExtension<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(ObjectExtension 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 ObjectExtension

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(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).

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 BaseReceivingAntennaExtension.checkForSameDefinition(agi.foundation.infrastructure.ObjectExtension) method.

Overrides:

computeCurrentDefinitionHashCode in class ObjectExtension

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 ObjectExtension

Parameters:

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

freezeAggregatedObjects

protected void freezeAggregatedObjects()

Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.

Overrides:

freezeAggregatedObjects in class DefinitionalObject

getService

public Object getService(Class<?> serviceType)

Gets the service object of the specified type.

Specified by:

getService in interface IServiceProvider

Overrides:

getService in class ObjectExtension

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.

getOutputSignalProcessor

public final SignalProcessor getOutputSignalProcessor()

Gets the SignalProcessor which produces the antenna's signal output.

Specified by:

getOutputSignalProcessor in interface ISignalReceivedByAntennaService

getAntennaSignalProcessor

protected final AntennaSignalProcessor<TGainPattern> getAntennaSignalProcessor()

Gets the antenna signal processor which produces the antenna's signal output.

setAntennaSignalProcessor

protected final void setAntennaSignalProcessor(AntennaSignalProcessor<TGainPattern> value)

Sets the antenna signal processor which produces the antenna's signal output.

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.

getAntennaGainPattern

public final TGainPattern getAntennaGainPattern()

Gets the gain pattern for this antenna.

Specified by:

getAntennaGainPattern in interface IReceivingAntennaExtension<TGainPattern extends BaseGainPattern>

setAntennaGainPattern

public final void setAntennaGainPattern(TGainPattern value)

Sets the gain pattern for this antenna.

Specified by:

setAntennaGainPattern in interface IReceivingAntennaExtension<TGainPattern extends BaseGainPattern>

getPolarizationSource

public PolarizationSource getPolarizationSource()

Gets the polarization source.

setPolarizationSource

public 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.