agi.foundation.communications.signalprocessing

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

Class PulsedSignalData

java.lang.Object

agi.foundation.communications.signalprocessing.PulsedSignalData

All Implemented Interfaces:

IEquatable<PulsedSignalData>

public class PulsedSignalData
extends Object
implements IEquatable<PulsedSignalData>

Signal data which represents the properties of a rectangular waveform. A waveform is defined as a number of pulses, defined by PulseCount (get), with duty cycle defined by the PulseWidth (get) and PulseRepetitionFrequency (get).

Constructor Summary

Constructors

Constructor and Description
PulsedSignalData(double pulseRepetitionFrequency, double pulseWidth, int pulseCount) Creates a new instance.
PulsedSignalData(PulsedSignalData 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.
static boolean	equals(PulsedSignalData left, PulsedSignalData right) Returns true if the two instances are exactly equal.
boolean	equalsType(PulsedSignalData other) Indicates whether another instance of this type is exactly equal to this instance.
int	getPulseCount() Gets the pulse count.
double	getPulseRepetitionFrequency() Gets the pulse repetition frequency.
double	getPulseWidth() Gets the pulse width.
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(PulsedSignalData left, PulsedSignalData 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

PulsedSignalData

public PulsedSignalData(double pulseRepetitionFrequency,
                        double pulseWidth,
                        int pulseCount)

Creates a new instance.

Parameters:

pulseRepetitionFrequency - The pulse repetition frequency.

pulseWidth - The pulse width.

pulseCount - The pulse count.

PulsedSignalData

public PulsedSignalData(@Nonnull
                        PulsedSignalData 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

getPulseRepetitionFrequency

public final double getPulseRepetitionFrequency()

Gets the pulse repetition frequency.

getPulseWidth

public final double getPulseWidth()

Gets the pulse width.

getPulseCount

public final int getPulseCount()

Gets the pulse count.

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

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

Specified by:

equalsType in interface IEquatable<PulsedSignalData>

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)

equals

public static boolean equals(PulsedSignalData left,
                             PulsedSignalData 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(PulsedSignalData left,
                                PulsedSignalData 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.