GnssSignalType

public final class GnssSignalType
extends Object implements Parcelable

java.lang.Object
   ↳ android.location.GnssSignalType


This class represents a GNSS signal type.

Summary

Inherited constants

Fields

public static final Creator<GnssSignalType> CREATOR

Public methods

static GnssSignalType create(int constellationType, double carrierFrequencyHz, String codeType)

Creates a GnssSignalType with a full list of parameters.

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

double getCarrierFrequencyHz()

Returns the carrier frequency in Hz.

String getCodeType()

Return the code type.

int getConstellationType()

Returns the constellation type.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 34
public static final Creator<GnssSignalType> CREATOR

Public methods

create

Added in API level 34
public static GnssSignalType create (int constellationType, 
                double carrierFrequencyHz, 
                String codeType)

Creates a GnssSignalType with a full list of parameters.

Parameters
constellationType int: the constellation type Value is GnssStatus.CONSTELLATION_UNKNOWN, GnssStatus.CONSTELLATION_GPS, GnssStatus.CONSTELLATION_SBAS, GnssStatus.CONSTELLATION_GLONASS, GnssStatus.CONSTELLATION_QZSS, GnssStatus.CONSTELLATION_BEIDOU, GnssStatus.CONSTELLATION_GALILEO, or GnssStatus.CONSTELLATION_IRNSS

carrierFrequencyHz double: the carrier frequency in Hz Value is 0.0f or greater

codeType String: the code type as defined in GnssMeasurement#getCodeType() This value cannot be null.

Returns
GnssSignalType This value cannot be null.

describeContents

Added in API level 34
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34
public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getCarrierFrequencyHz

Added in API level 34
public double getCarrierFrequencyHz ()

Returns the carrier frequency in Hz.

Returns
double Value is 0.0f or greater

getCodeType

Added in API level 34
public String getCodeType ()

Return the code type.

Returns
String This value cannot be null.

hashCode

Added in API level 34
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

Added in API level 34
public String toString ()

Returns a string representation of the object.

Returns
String This value cannot be null.

writeToParcel

Added in API level 34
public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES