agi.foundation.communications

(agi.foundation.communications-2023r1.jar)

Class Ieee1979PolarizationSource

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.PolarizationSource

agi.foundation.communications.Ieee1979PolarizationSource

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class Ieee1979PolarizationSource
extends PolarizationSource

A polarization source which produces polarization based on the link geometry and measured antenna data which conforms to the IEEE Std 149-1979 "IEEE Standard Test Procedures for Antennas".

Constructor Summary

Constructors

Modifier	Constructor and Description
	Ieee1979PolarizationSource(double[] clockAngleValues, double[] coneAngleValues, double[][] gainValuesRightHandCircular, double[][] gainValuesLeftHandCircular, double[][] tiltAngleValues, boolean gainValuesAreDecibel, boolean gainInterpolationDecibelScale) Initializes a new instance.
	Ieee1979PolarizationSource(double[] clockAngleValues, double[] coneAngleValues, double[][] gainValuesRightHandCircular, double[][] gainValuesLeftHandCircular, double[][] tiltAngleValues, boolean gainValuesAreDecibel, boolean gainInterpolationDecibelScale, PolarizationReferenceAxis referenceAxis) Initializes a new instance.
protected	Ieee1979PolarizationSource(Ieee1979PolarizationSource existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(Ieee1979PolarizationSource other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(PolarizationSource other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
List<Double>	getClockAngleValues() Gets the list of clock angle values that specify the azimuthal angle measured from the x-axis in the x-y plane.
List<Double>	getConeAngleValues() Gets the list of cone angle values that specify the zenith angle measured from the z-axis.
boolean	getGainInterpolationDecibelScale() Gets a value indicating whether or not the interpolation will be performed in decibels.
double	getGainLeftHandCircular(int clockAngleIndex, int coneAngleIndex) Gets the left-hand circular gain value at the given clock angle, cone angle indices.
double	getGainRightHandCircular(int clockAngleIndex, int coneAngleIndex) Gets the right-hand circular gain value at the given clock angle, cone angle indices.
SignalPolarizationEvaluator	getPolarizationEvaluator(EvaluatorGroup group, Vector linkGeometry, Axes polarizationAxes) Gets an evaluator for evaluating polarization based on link geometry and polarization axes.
PolarizationReferenceAxis	getPolarizationReferenceAxis() Gets the polarization reference axis.
double	getTau(int clockAngleIndex, int coneAngleIndex) Gets the tilt angle value at the given clock angle, cone angle indices.

Methods inherited from class agi.foundation.communications.PolarizationSource

checkForSameDefinition, toPolarizationSource

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

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

Ieee1979PolarizationSource

public Ieee1979PolarizationSource(@Nonnull
                                  double[] clockAngleValues,
                                  @Nonnull
                                  double[] coneAngleValues,
                                  @Nonnull
                                  double[][] gainValuesRightHandCircular,
                                  @Nonnull
                                  double[][] gainValuesLeftHandCircular,
                                  @Nonnull
                                  double[][] tiltAngleValues,
                                  boolean gainValuesAreDecibel,
                                  boolean gainInterpolationDecibelScale)

Initializes a new instance.

Parameters:

clockAngleValues - An array of values which represent the clock angle of the spherical coordinate system.

coneAngleValues - An array of values which represent the cone angle of the spherical coordinate system.

gainValuesRightHandCircular - A multidimensional array which represents the measured right hand circular gain values. The length of the first dimension of the array must be equal to the length of the clock angles array. The length of the second dimension must be equal to the length of the cone angles array.

gainValuesLeftHandCircular - A multidimensional array which represents the measured left hand circular gain values. The length of the first dimension of the array must be equal to the length of the clock angles array. The length of the second dimension must be equal to the length of the cone angles array.

tiltAngleValues - A multidimensional array which represents the measured tilt angle values. The length of the first dimension of the array must be equal to the length of the clock angles array. The length of the second dimension must be equal to the length of the cone angles array.

gainValuesAreDecibel - Indicates whether or not the right hand circular and left hand circular gain arrays are in decibel or linear scale. If true, this indicates that gain is in decibels, otherwise they are interpreted as linear scale.

gainInterpolationDecibelScale - Indicates whether or not gain interpolation should occur in decibel or linear scale. If true, the gain in interpolated in decibels, otherwise interpolation occurs in linear scale.

Ieee1979PolarizationSource

public Ieee1979PolarizationSource(@Nonnull
                                  double[] clockAngleValues,
                                  @Nonnull
                                  double[] coneAngleValues,
                                  @Nonnull
                                  double[][] gainValuesRightHandCircular,
                                  @Nonnull
                                  double[][] gainValuesLeftHandCircular,
                                  @Nonnull
                                  double[][] tiltAngleValues,
                                  boolean gainValuesAreDecibel,
                                  boolean gainInterpolationDecibelScale,
                                  @Nonnull
                                  PolarizationReferenceAxis referenceAxis)

Initializes a new instance.

Parameters:

clockAngleValues - An array of values which represent the clock angle of the spherical coordinate system.

coneAngleValues - An array of values which represent the cone angle of the spherical coordinate system.

gainValuesRightHandCircular - A multidimensional array which represents the measured right hand circular gain values. The length of the first dimension of the array must be equal to the length of the clock angles array. The length of the second dimension must be equal to the length of the cone angles array.

gainValuesLeftHandCircular - A multidimensional array which represents the measured left hand circular gain values. The length of the first dimension of the array must be equal to the length of the clock angles array. The length of the second dimension must be equal to the length of the cone angles array.

tiltAngleValues - A multidimensional array which represents the measured tilt angle values. The length of the first dimension of the array must be equal to the length of the clock angles array. The length of the second dimension must be equal to the length of the cone angles array.

gainValuesAreDecibel - Indicates whether or not the right hand circular and left hand circular gain arrays are in decibel or linear scale. If true, this indicates that gain is in decibels, otherwise they are interpreted as linear scale.

gainInterpolationDecibelScale - Indicates whether or not gain interpolation should occur in decibel or linear scale. If true, the gain in interpolated in decibels, otherwise interpolation occurs in linear scale.

referenceAxis - The reference axis from which the tilt angle is measured.

Ieee1979PolarizationSource

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

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(PolarizationSource 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 PolarizationSource

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(Ieee1979PolarizationSource 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 Ieee1979PolarizationSource.checkForSameDefinition(agi.foundation.communications.PolarizationSource) method.

Overrides:

computeCurrentDefinitionHashCode in class PolarizationSource

Returns:

The computed hash code.

getPolarizationEvaluator

public SignalPolarizationEvaluator getPolarizationEvaluator(EvaluatorGroup group,
                                                            Vector linkGeometry,
                                                            Axes polarizationAxes)

Gets an evaluator for evaluating polarization based on link geometry and polarization axes.

Specified by:

getPolarizationEvaluator in class PolarizationSource

Parameters:

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

linkGeometry - The vector which represents the link direction.

polarizationAxes - The polarization axes.

Returns:

An evaluator for evaluating signal polarization.

getClockAngleValues

@Nonnull
public final List<Double> getClockAngleValues()

Gets the list of clock angle values that specify the azimuthal angle measured from the x-axis in the x-y plane.

getConeAngleValues

@Nonnull
public final List<Double> getConeAngleValues()

Gets the list of cone angle values that specify the zenith angle measured from the z-axis.

getGainRightHandCircular

public final double getGainRightHandCircular(int clockAngleIndex,
                                             int coneAngleIndex)

Gets the right-hand circular gain value at the given clock angle, cone angle indices.

Parameters:

clockAngleIndex - The desired clock angle index.

coneAngleIndex - the desired cone angle index.

Returns:

The gain in linear units.

getGainLeftHandCircular

public final double getGainLeftHandCircular(int clockAngleIndex,
                                            int coneAngleIndex)

Gets the left-hand circular gain value at the given clock angle, cone angle indices.

Parameters:

clockAngleIndex - The desired clock angle index.

coneAngleIndex - the desired cone angle index.

Returns:

The gain in linear units.

getTau

public final double getTau(int clockAngleIndex,
                           int coneAngleIndex)

Gets the tilt angle value at the given clock angle, cone angle indices.

Parameters:

clockAngleIndex - The desired clock angle index.

coneAngleIndex - the desired cone angle index.

Returns:

The tilt angle.

getGainInterpolationDecibelScale

public final boolean getGainInterpolationDecibelScale()

Gets a value indicating whether or not the interpolation will be performed in decibels.

getPolarizationReferenceAxis

@Nonnull
public final PolarizationReferenceAxis getPolarizationReferenceAxis()

Gets the polarization reference axis.