agi.foundation.communications

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

Class ElectricFieldVectorComponents

java.lang.Object

agi.foundation.communications.ElectricFieldVectorComponents

All Implemented Interfaces:

IEquatable<ElectricFieldVectorComponents>, ImmutableValueType, ValueType

public final class ElectricFieldVectorComponents
extends Object
implements IEquatable<ElectricFieldVectorComponents>, ImmutableValueType

Defines the horizontal and vertical electric field vector components of a signal.

Constructor Summary

Constructors

Constructor and Description
ElectricFieldVectorComponents() Initializes a new instance.
ElectricFieldVectorComponents(Complex horizontalVectorComponent, Complex verticalVectorComponent) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
Polarization	computePolarization(PolarizationReferenceAxis referenceAxis) Computes polarization based on the horizontal and vertical vector components and the supplied polarization reference axis.
static boolean	equals(ElectricFieldVectorComponents left, ElectricFieldVectorComponents right) Returns true if the two instances are exactly equal.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(ElectricFieldVectorComponents other) Indicates whether another instance of this type is exactly equal to this instance.
Complex	getHorizontalVectorComponent() Gets the horizontal polarization electric field component.
static ElectricFieldVectorComponents	getUndefined() Gets a ElectricFieldVectorComponents with values of 0.0 for both the horizontal and vertical component's real and imaginary parts.
Complex	getVerticalVectorComponent() Gets the vertical polarization electric field component.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(ElectricFieldVectorComponents left, ElectricFieldVectorComponents right) Returns true if the two instances are not exactly equal.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ElectricFieldVectorComponents

public ElectricFieldVectorComponents()

Initializes a new instance.

ElectricFieldVectorComponents

public ElectricFieldVectorComponents(@Nonnull
                                     Complex horizontalVectorComponent,
                                     @Nonnull
                                     Complex verticalVectorComponent)

Initializes a new instance.

Parameters:

horizontalVectorComponent - The horizontal polarization electric field component.

verticalVectorComponent - The vertical polarization electric field component.

Method Detail

getHorizontalVectorComponent

@Nonnull
public final Complex getHorizontalVectorComponent()

Gets the horizontal polarization electric field component.

getVerticalVectorComponent

@Nonnull
public final Complex getVerticalVectorComponent()

Gets the vertical polarization electric field component.

computePolarization

public final Polarization computePolarization(@Nonnull
                                              PolarizationReferenceAxis referenceAxis)

Computes polarization based on the horizontal and vertical vector components and the supplied polarization reference axis.

Parameters:

referenceAxis - The desired polarization reference axis of the resulting polarization.

Returns:

The computed Polarization instance or null. If null is returned, either the horizontal or vertical electric field magnitude is less than CommunicationsConstants.MinimumElectricFieldValue

equals

public static boolean equals(@Nonnull
                             ElectricFieldVectorComponents left,
                             @Nonnull
                             ElectricFieldVectorComponents right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                ElectricFieldVectorComponents left,
                                @Nonnull
                                ElectricFieldVectorComponents right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(@Nonnull
                                ElectricFieldVectorComponents other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<ElectricFieldVectorComponents>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

getUndefined

@Nonnull
public static ElectricFieldVectorComponents getUndefined()

Gets a ElectricFieldVectorComponents with values of 0.0 for both the horizontal and vertical component's real and imaginary parts.