19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2008 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.location; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This class represents the current state of a GPS satellite. 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This class is used in conjunction with the {@link GpsStatus} class. 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic final class GpsSatellite { 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* These package private values are modified by the GpsStatus class */ 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean mValid; 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean mHasEphemeris; 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean mHasAlmanac; 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean mUsedInFix; 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int mPrn; 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project float mSnr; 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project float mElevation; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project float mAzimuth; 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project GpsSatellite(int prn) { 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPrn = prn; 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Used by {@link LocationManager#getGpsStatus} to copy LocationManager's 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * cached GpsStatus instance to the client's copy. 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void setStatus(GpsSatellite satellite) { 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mValid = satellite.mValid; 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mHasEphemeris = satellite.mHasEphemeris; 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mHasAlmanac = satellite.mHasAlmanac; 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mUsedInFix = satellite.mUsedInFix; 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mSnr = satellite.mSnr; 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mElevation = satellite.mElevation; 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mAzimuth = satellite.mAzimuth; 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the PRN (pseudo-random number) for the satellite. 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return PRN number 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getPrn() { 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPrn; 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the signal to noise ratio for the satellite. 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the signal to noise ratio 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public float getSnr() { 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mSnr; 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the elevation of the satellite in degrees. 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The elevation can vary between 0 and 90. 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the elevation in degrees 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public float getElevation() { 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mElevation; 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the azimuth of the satellite in degrees. 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The azimuth can vary between 0 and 360. 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the azimuth in degrees 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public float getAzimuth() { 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mAzimuth; 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns true if the GPS engine has ephemeris data for the satellite. 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if the satellite has ephemeris data 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean hasEphemeris() { 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mHasEphemeris; 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns true if the GPS engine has almanac data for the satellite. 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if the satellite has almanac data 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean hasAlmanac() { 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mHasAlmanac; 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns true if the satellite was used by the GPS engine when 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * calculating the most recent GPS fix. 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if the satellite was used to compute the most recent fix. 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean usedInFix() { 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mUsedInFix; 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 118