agi.foundation.navigation.datareaders

(agi.foundation.navigation-2026r1.jar)

Class SatelliteIdentifier

java.lang.Object

agi.foundation.navigation.datareaders.SatelliteIdentifier

All Implemented Interfaces:

IEquatable<SatelliteIdentifier>, ImmutableValueType, ValueType, Comparable<SatelliteIdentifier>

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

Satellite Identifier structure for SP3-c and SP3-d files. Contains the integer satellite identifier and the character constellation type.

See Also:

SP3cEphemeris, SP3dEphemeris

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
int	compareTo(SatelliteIdentifier other) Compares this instance with another instance of the same type.
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.
static boolean	greaterThan(SatelliteIdentifier left, SatelliteIdentifier right) Returns true if left is greater than right.
static boolean	greaterThanOrEqual(SatelliteIdentifier left, SatelliteIdentifier right) Returns true if left is greater than or equal to right.
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	lessThan(SatelliteIdentifier left, SatelliteIdentifier right) Returns true if left is less than right.
static boolean	lessThanOrEqual(SatelliteIdentifier left, SatelliteIdentifier right) Returns true if left is less than or equal to right.
static boolean	notEquals(SatelliteIdentifier left, SatelliteIdentifier right) Returns true if the two instances are not exactly equal.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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 SP3-c 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 SP3-c 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)

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

compareTo

public final int compareTo(@Nonnull
                           SatelliteIdentifier other)

Compares this instance with another instance of the same type.

Specified by:

compareTo in interface Comparable<SatelliteIdentifier>

Parameters:

other - An object to compare with this instance.

Returns:

A value indicating the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance is less than other.
Zero	This instance is equal to other.
Greater than zero	This instance is greater than other.

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.

lessThan

public static boolean lessThan(@Nonnull
                               SatelliteIdentifier left,
                               @Nonnull
                               SatelliteIdentifier right)

Returns true if left is less than right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is less than right; otherwise false.

greaterThan

public static boolean greaterThan(@Nonnull
                                  SatelliteIdentifier left,
                                  @Nonnull
                                  SatelliteIdentifier right)

Returns true if left is greater than right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is greater than right; otherwise false.

lessThanOrEqual

public static boolean lessThanOrEqual(@Nonnull
                                      SatelliteIdentifier left,
                                      @Nonnull
                                      SatelliteIdentifier right)

Returns true if left is less than or equal to right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is less than or equal to right; otherwise false.

greaterThanOrEqual

public static boolean greaterThanOrEqual(@Nonnull
                                         SatelliteIdentifier left,
                                         @Nonnull
                                         SatelliteIdentifier right)

Returns true if left is greater than or equal to right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is greater than or equal to right; otherwise false.