agi.foundation.navigation.datareaders

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

Class SatelliteIdentifier

java.lang.Object

agi.foundation.navigation.datareaders.SatelliteIdentifier

All Implemented Interfaces:

IEquatable<SatelliteIdentifier>, ImmutableValueType, ValueType

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

Satellite Identifier structure for SP3c files. Contains the integer satellite identifier and the character constellation type.

Constructor Summary

Constructors

Constructor and Description
SatelliteIdentifier() Initializes a new instance.
SatelliteIdentifier(char satelliteConstellationType, int satelliteId) Initializes a new 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(SatelliteIdentifier left, SatelliteIdentifier right) Returns true if the two instances are exactly equal.
boolean	equalsType(SatelliteIdentifier other) Indicates whether another instance of this type is exactly equal to this instance.
char	getSatelliteConstellationType() Gets the constellation type for this satellite.
int	getSatelliteId() Gets the integer ID of the satellite.
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(SatelliteIdentifier left, SatelliteIdentifier 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

SatelliteIdentifier

public SatelliteIdentifier()

Initializes a new instance.

SatelliteIdentifier

public SatelliteIdentifier(char satelliteConstellationType,
                           int satelliteId)

Initializes a new instance.

Parameters:

satelliteConstellationType - The constellation type for this satellite. From the SP3c file definition document, the following definitions apply: 'G' denotes GPS constellation. 'R' denotes GLONASS constellation. 'L' denotes Low-Earth orbit satellites. 'E' denotes Galileo constellation.

satelliteId - The integer ID of the satellite. For GPS constellations, this is the PseudoRandom Noise number (PRN).

Method Detail

getSatelliteId

public final int getSatelliteId()

Gets the integer ID of the satellite. For GPS constellations, this is the PseudoRandom Noise number (PRN).

getSatelliteConstellationType

public final char getSatelliteConstellationType()

Gets the constellation type for this satellite. From the SP3c file definition document, the following definitions apply:

• 'G' denotes GPS constellation
• 'R' denotes GLONASS constellation
• 'L' denotes Low-Earth orbit satellites
• 'E' denotes Galileo constellation.

equalsType

public final boolean equalsType(@Nonnull
                                SatelliteIdentifier other)

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

Specified by:

equalsType in interface IEquatable<SatelliteIdentifier>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; 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

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(@Nonnull
                             SatelliteIdentifier left,
                             @Nonnull
                             SatelliteIdentifier 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
                                SatelliteIdentifier left,
                                @Nonnull
                                SatelliteIdentifier 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.