agi.foundation.communications

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

Class PolarizationSource

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.PolarizationSource

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ConstantPolarizationSource, FrequencyDependentElectricFieldPolarizationSource, Ieee1979PolarizationSource, OrthogonalPolarizationSource

public abstract class PolarizationSource
extends DefinitionalObject

Base class for a polarization source which provides an evaluator for evaluating polarization over time based on the link geometry and polarization axes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PolarizationSource() Initializes a new instance.
protected	PolarizationSource(PolarizationSource 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(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(PolarizationSource 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.
abstract SignalPolarizationEvaluator	getPolarizationEvaluator(EvaluatorGroup group, Vector linkGeometry, Axes polarizationAxes) Gets an evaluator for evaluating polarization based on link geometry and polarization axes.
static PolarizationSource	toPolarizationSource(Polarization value) Converts a Polarization to a PolarizationSource.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, 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

PolarizationSource

protected PolarizationSource()

Initializes a new instance.

PolarizationSource

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

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

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

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getPolarizationEvaluator

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

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

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.

toPolarizationSource

public static PolarizationSource toPolarizationSource(Polarization value)

Converts a Polarization to a PolarizationSource.

Parameters:

value - The value to convert.

Returns:

A new PolarizationSource configured with the given Polarization, or null if value is null.