agi.foundation.communications.antennas

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

Class BaseTransmittingAntennaExtension<TGainPattern extends BaseGainPattern>

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.infrastructure.ObjectExtension

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

Type Parameters:

TGainPattern - The type of antenna gain pattern.

All Implemented Interfaces:

ISignalToTransmitService, ISignalTransmissionService, ITransmittingAntennaExtension<TGainPattern>, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

BaseDualPolarizedTransmittingAntennaExtension, OpticalTransmittingAntennaExtension, RadarTransmittingAntennaExtension, RadioFrequencyTransmittingAntennaExtension

public abstract class BaseTransmittingAntennaExtension<TGainPattern extends BaseGainPattern>
extends ObjectExtension
implements ITransmittingAntennaExtension<TGainPattern>

An extension which takes a signal source and transmits a wireless signal through an antenna. This provides the ISignalTransmissionService.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseTransmittingAntennaExtension(BaseTransmittingAntennaExtension<TGainPattern> existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	BaseTransmittingAntennaExtension(SignalProcessor inputSignalProcessor, TGainPattern antennaGainPattern) Initialize a new instance based on the given gain pattern and a signal processor which produces the set of signals to transmit.
protected	BaseTransmittingAntennaExtension(SignalProcessor input, TGainPattern antennaGainPattern, PolarizationSource polarizationSource) Initialize a new instance based on the given gain pattern, a signal processor which produces the set of signals to transmit, and a polarization source which generates the transmit polarization.
protected	BaseTransmittingAntennaExtension(TGainPattern antennaGainPattern) Initializes a new instance with a given antenna gain pattern.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(BaseTransmittingAntennaExtension<TGainPattern> 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.
TGainPattern	getAntennaGainPattern() Gets the gain pattern for this antenna.
SignalProcessor	getInputSignalProcessor() Gets the signal processor which produces the set of signals to transmit through the antenna.
PolarizationSource	getPolarizationSource() Gets the polarization source.
Object	getService(Class<?> serviceType) Gets the service object of the specified type.
Axes	getSignalTransmissionAxes() Gets the Axes associated with signal transmission.
SignalEvaluator	getSignalTransmissionEvaluator(EvaluatorGroup group, Vector reflectedVector, SignalPropagationGraph graph) Gets an evaluator which produces the transmitted signal after applying the gain in the link direction.
void	setAntennaGainPattern(TGainPattern value) Sets the gain pattern for this antenna.
void	setInputSignalProcessor(SignalProcessor value) Sets the signal processor which produces the set of signals to transmit through the antenna.
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, 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

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

getOwner

Constructor Detail

BaseTransmittingAntennaExtension

protected BaseTransmittingAntennaExtension(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.

BaseTransmittingAntennaExtension

protected BaseTransmittingAntennaExtension(SignalProcessor inputSignalProcessor,
                                           TGainPattern antennaGainPattern)

Initialize a new instance based on the given gain pattern and a signal processor which produces the set of signals to transmit.

Parameters:

inputSignalProcessor - The signal processor which produces the set of signals to transmit.

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.

BaseTransmittingAntennaExtension

protected BaseTransmittingAntennaExtension(SignalProcessor input,
                                           TGainPattern antennaGainPattern,
                                           PolarizationSource polarizationSource)

Initialize a new instance based on the given gain pattern, a signal processor which produces the set of signals to transmit, and a polarization source which generates the transmit polarization.

Parameters:

input - The signal processor which produces the set of signals to transmit.

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.

polarizationSource - The polarization source for modeling polarization efficiency.

BaseTransmittingAntennaExtension

protected BaseTransmittingAntennaExtension(@Nonnull
                                           BaseTransmittingAntennaExtension<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(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(BaseTransmittingAntennaExtension<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 BaseTransmittingAntennaExtension.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.

getInputSignalProcessor

public SignalProcessor getInputSignalProcessor()

Gets the signal processor which produces the set of signals to transmit through the antenna.

Specified by:

getInputSignalProcessor in interface ISignalToTransmitService

setInputSignalProcessor

public void setInputSignalProcessor(SignalProcessor value)

Sets the signal processor which produces the set of signals to transmit through the antenna.

getPolarizationSource

public final PolarizationSource getPolarizationSource()

Gets the polarization source.

setPolarizationSource

public final void setPolarizationSource(PolarizationSource value)

Sets the polarization source.

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.

getAntennaGainPattern

public final TGainPattern getAntennaGainPattern()

Gets the gain pattern for this antenna.

Specified by:

getAntennaGainPattern in interface ITransmittingAntennaExtension<TGainPattern extends BaseGainPattern>

setAntennaGainPattern

public final void setAntennaGainPattern(TGainPattern value)

Sets the gain pattern for this antenna.

Specified by:

setAntennaGainPattern in interface ITransmittingAntennaExtension<TGainPattern extends BaseGainPattern>

getSignalTransmissionEvaluator

public SignalEvaluator getSignalTransmissionEvaluator(EvaluatorGroup group,
                                                      Vector reflectedVector,
                                                      SignalPropagationGraph graph)

Gets an evaluator which produces the transmitted signal after applying the gain in the link direction.

Specified by:

getSignalTransmissionEvaluator in interface ISignalTransmissionService

Parameters:

group - The evaluator group in which to create the evaluator.

reflectedVector - The link geometry used by the antenna gain pattern.

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

Returns:

An evaluator which produces the transmitted signal after applying the antenna gain.

Throws:

ArgumentNullException - Thrown if group, reflectedVector, or graph is null.

PropertyInvalidException - Thrown if Owner (get / set), InputSignalProcessor (get / set), or AntennaGainPattern (get / set) is null.

getSignalTransmissionAxes

public final Axes getSignalTransmissionAxes()

Gets the Axes associated with signal transmission.

Specified by:

getSignalTransmissionAxes in interface ISignalTransmissionService

Returns:

The Axes associated with signal transmission.