Skip to content

Most visited

Recently visited

navigation

GnssNavigationMessage

public final class GnssNavigationMessage
extends Object implements Parcelable

java.lang.Object
   ↳ android.location.GnssNavigationMessage


A class containing a GNSS satellite Navigation Message.

Summary

Nested classes

class GnssNavigationMessage.Callback

Used for receiving GNSS satellite Navigation Messages from the GNSS engine. 

Constants

int STATUS_PARITY_PASSED

The Navigation Message was received without any parity error in its navigation words.

int STATUS_PARITY_REBUILT

The Navigation Message was received with words that failed parity check, but the receiver was able to correct those words.

int STATUS_UNKNOWN

The Navigation Message Status is 'unknown'.

int TYPE_BDS_D1

Beidou D1 message contained in the structure.

int TYPE_BDS_D2

Beidou D2 message contained in the structure.

int TYPE_GAL_F

Galileo F/NAV message contained in the structure.

int TYPE_GAL_I

Galileo I/NAV message contained in the structure.

int TYPE_GLO_L1CA

Glonass L1 CA message contained in the structure.

int TYPE_GPS_CNAV2

GPS CNAV-2 message contained in the structure.

int TYPE_GPS_L1CA

GPS L1 C/A message contained in the structure.

int TYPE_GPS_L2CNAV

GPS L2-CNAV message contained in the structure.

int TYPE_GPS_L5CNAV

GPS L5-CNAV message contained in the structure.

int TYPE_UNKNOWN

Message type unknown

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<GnssNavigationMessage> CREATOR

Public methods

int describeContents()

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

byte[] getData()

Gets the data of the reported GPS message.

int getMessageId()

Gets the Message identifier.

int getStatus()

Gets the Status of the navigation message contained in the object.

int getSubmessageId()

Gets the sub-message identifier, relevant to the getType() of the message.

int getSvid()

Gets the satellite ID.

int getType()

Gets the type of the navigation message contained in 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

From class java.lang.Object
From interface android.os.Parcelable

Constants

STATUS_PARITY_PASSED

added in API level 24
int STATUS_PARITY_PASSED

The Navigation Message was received without any parity error in its navigation words.

Constant Value: 1 (0x00000001)

STATUS_PARITY_REBUILT

added in API level 24
int STATUS_PARITY_REBUILT

The Navigation Message was received with words that failed parity check, but the receiver was able to correct those words.

Constant Value: 2 (0x00000002)

STATUS_UNKNOWN

added in API level 24
int STATUS_UNKNOWN

The Navigation Message Status is 'unknown'.

Constant Value: 0 (0x00000000)

TYPE_BDS_D1

added in API level 24
int TYPE_BDS_D1

Beidou D1 message contained in the structure.

Constant Value: 1281 (0x00000501)

TYPE_BDS_D2

added in API level 24
int TYPE_BDS_D2

Beidou D2 message contained in the structure.

Constant Value: 1282 (0x00000502)

TYPE_GAL_F

added in API level 24
int TYPE_GAL_F

Galileo F/NAV message contained in the structure.

Constant Value: 1538 (0x00000602)

TYPE_GAL_I

added in API level 24
int TYPE_GAL_I

Galileo I/NAV message contained in the structure.

Constant Value: 1537 (0x00000601)

TYPE_GLO_L1CA

added in API level 24
int TYPE_GLO_L1CA

Glonass L1 CA message contained in the structure.

Constant Value: 769 (0x00000301)

TYPE_GPS_CNAV2

added in API level 24
int TYPE_GPS_CNAV2

GPS CNAV-2 message contained in the structure.

Constant Value: 260 (0x00000104)

TYPE_GPS_L1CA

added in API level 24
int TYPE_GPS_L1CA

GPS L1 C/A message contained in the structure.

Constant Value: 257 (0x00000101)

TYPE_GPS_L2CNAV

added in API level 24
int TYPE_GPS_L2CNAV

GPS L2-CNAV message contained in the structure.

Constant Value: 258 (0x00000102)

TYPE_GPS_L5CNAV

added in API level 24
int TYPE_GPS_L5CNAV

GPS L5-CNAV message contained in the structure.

Constant Value: 259 (0x00000103)

TYPE_UNKNOWN

added in API level 24
int TYPE_UNKNOWN

Message type unknown

Constant Value: 0 (0x00000000)

Fields

CREATOR

added in API level 24
Creator<GnssNavigationMessage> CREATOR

Public methods

describeContents

added in API level 24
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(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.

getData

added in API level 24
byte[] getData ()

Gets the data of the reported GPS message.

The bytes (or words) specified using big endian format (MSB first).

  • For GPS L1 C/A, Beidou D1 & Beidou D2, each subframe contains 10 30-bit words. Each word (30 bits) should be fit into the last 30 bits in a 4-byte word (skip B31 and B32), with MSB first, for a total of 40 bytes, covering a time period of 6, 6, and 0.6 seconds, respectively.
  • For Glonass L1 C/A, each string contains 85 data bits, including the checksum. These bits should be fit into 11 bytes, with MSB first (skip B86-B88), covering a time period of 2 seconds.
  • For Galileo F/NAV, each word consists of 238-bit (sync & tail symbols excluded). Each word should be fit into 30-bytes, with MSB first (skip B239, B240), covering a time period of 10 seconds.
  • For Galileo I/NAV, each page contains 2 page parts, even and odd, with a total of 2x114 = 228 bits, (sync & tail excluded) that should be fit into 29 bytes, with MSB first (skip B229-B232).

Returns
byte[]

This value will never be null.

getMessageId

added in API level 24
int getMessageId ()

Gets the Message identifier.

This provides an index to help with complete Navigation Message assembly. Similar identifiers within the data bits themselves often supplement this information, in ways even more specific to each message type; see the relevant satellite constellation ICDs for details.

  • For GPS L1 C/A subframe 4 and 5, this value corresponds to the 'frame id' of the navigation message, in the range of 1-25 (Subframe 1, 2, 3 does not contain a 'frame id' and this value can be set to -1.)
  • For Glonass L1 C/A, this refers to the frame ID, in the range of 1-5.
  • For BeiDou D1, this refers to the frame number in the range of 1-24
  • For Beidou D2, this refers to the frame number, in the range of 1-120
  • For Galileo F/NAV nominal frame structure, this refers to the subframe number, in the range of 1-12
  • For Galileo I/NAV nominal frame structure, this refers to the subframe number in the range of 1-24

Returns
int

getStatus

added in API level 24
int getStatus ()

Gets the Status of the navigation message contained in the object.

Returns
int

getSubmessageId

added in API level 24
int getSubmessageId ()

Gets the sub-message identifier, relevant to the getType() of the message.

  • For GPS L1 C/A, BeiDou D1 & BeiDou D2, the submessage id corresponds to the subframe number of the navigation message, in the range of 1-5.
  • For Glonass L1 C/A, this refers to the String number, in the range from 1-15
  • For Galileo F/NAV, this refers to the page type in the range 1-6
  • For Galileo I/NAV, this refers to the word type in the range 1-10+
  • For Galileo in particular, the type information embedded within the data bits may be even more useful in interpretation, than the nominal page and word types provided in this field.

Returns
int

getSvid

added in API level 24
int getSvid ()

Gets the satellite ID.

Range varies by constellation. See definition at GnssStatus#getSvid(int)

Returns
int

getType

added in API level 24
int getType ()

Gets the type of the navigation message contained in the object.

Returns
int

toString

added in API level 24
String toString ()

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

Returns
String a string representation of the object.

writeToParcel

added in API level 24
void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.