agi.foundation.communications

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

Class SignalDopplerShiftData

java.lang.Object

agi.foundation.communications.SignalDopplerShiftData

public class SignalDopplerShiftData
extends Object

Signal data which tracks the frequency doppler shift for each point scatterer from which the signal is reflected.

Constructor Summary

Constructors

Constructor and Description
SignalDopplerShiftData() Initializes a new instance.
SignalDopplerShiftData(double dopplerShift) Initializes a new instance with a given doppler shift frequency, in hertz.

Method Summary

Modifier and Type	Method and Description
SignalDopplerShiftData	add(double dopplerShift) Returns a copy of the signal doppler shift data with the supplied doppler shift value added to the history collection.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
double	get(int index) Get the frequency doppler shift at the given index in the collection.
int	getCount() Gets the count of frequency doppler shift values.
double	getTotalDopplerShift() Gets the total doppler shift.
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

SignalDopplerShiftData

public SignalDopplerShiftData()

Initializes a new instance.

SignalDopplerShiftData

public SignalDopplerShiftData(double dopplerShift)

Initializes a new instance with a given doppler shift frequency, in hertz.

Parameters:

dopplerShift - The doppler shift value, in hertz.

Method Detail

getCount

public final int getCount()

Gets the count of frequency doppler shift values.

add

@Nonnull
public final SignalDopplerShiftData add(double dopplerShift)

Returns a copy of the signal doppler shift data with the supplied doppler shift value added to the history collection.

Parameters:

dopplerShift - The frequency doppler shift, in hertz.

Returns:

A new SignalDopplerShiftData.

get

public final double get(int index)

Get the frequency doppler shift at the given index in the collection.

Parameters:

index - The index into the collection of frequency doppler shifts.

Returns:

The doppler shift value, in hertz, for the supplied index into the doppler shift value array.

getTotalDopplerShift

public final double getTotalDopplerShift()

Gets the total doppler shift.

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

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)