agi.foundation.communications

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

Class FrequencySpecificElectricFieldPattern

java.lang.Object

agi.foundation.communications.FrequencySpecificElectricFieldPattern

All Implemented Interfaces:

IEquatable<FrequencySpecificElectricFieldPattern>

public class FrequencySpecificElectricFieldPattern
extends Object
implements IEquatable<FrequencySpecificElectricFieldPattern>

Defines a SphericalTabularElectricFieldPattern which is associated with a given frequency.

Constructor Summary

Constructors

Constructor and Description
FrequencySpecificElectricFieldPattern(double frequency, SphericalTabularElectricFieldPattern electricFieldPattern) Initializes an instance with the provided parameters
FrequencySpecificElectricFieldPattern(FrequencySpecificElectricFieldPattern existingInstance) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(FrequencySpecificElectricFieldPattern other) Indicates whether another instance of this type is exactly equal to this instance.
SphericalTabularElectricFieldPattern	getElectricFieldPattern() Gets the electric field pattern.
double	getFrequency() Gets the frequency at which the electric field pattern applies.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Methods inherited from class java.lang.Object

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

Constructor Detail

FrequencySpecificElectricFieldPattern

public FrequencySpecificElectricFieldPattern(double frequency,
                                             @Nonnull
                                             SphericalTabularElectricFieldPattern electricFieldPattern)

Initializes an instance with the provided parameters

Parameters:

frequency - The frequency at which the electric field pattern applies.

electricFieldPattern - The electric field pattern associated with the given frequency.

FrequencySpecificElectricFieldPattern

public FrequencySpecificElectricFieldPattern(@Nonnull
                                             FrequencySpecificElectricFieldPattern existingInstance)

Initializes a new instance as a copy of an existing instance.

Parameters:

existingInstance - The existing instance to copy.

Throws:

ArgumentNullException - Thrown when existingInstance is null.

Method Detail

getFrequency

public final double getFrequency()

Gets the frequency at which the electric field pattern applies.

getElectricFieldPattern

@Nonnull
public final SphericalTabularElectricFieldPattern getElectricFieldPattern()

Gets the electric field pattern.

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(FrequencySpecificElectricFieldPattern other)

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

Specified by:

equalsType in interface IEquatable<FrequencySpecificElectricFieldPattern>

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)