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. 21e8abe8e5ad830bd130b258c6801d75f6542200b5Lifu Tang * 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This class is used in conjunction with the {@link GpsStatus} class. 23e8abe8e5ad830bd130b258c6801d75f6542200b5Lifu Tang * 24e8abe8e5ad830bd130b258c6801d75f6542200b5Lifu Tang * @deprecated use {@link GnssStatus} and {@link GnssStatus.Callback}. 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 26e8abe8e5ad830bd130b258c6801d75f6542200b5Lifu Tang@Deprecated 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic final class GpsSatellite { 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* These package private values are modified by the GpsStatus class */ 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean mValid; 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean mHasEphemeris; 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean mHasAlmanac; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean mUsedInFix; 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int mPrn; 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project float mSnr; 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project float mElevation; 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project float mAzimuth; 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project GpsSatellite(int prn) { 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPrn = prn; 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Used by {@link LocationManager#getGpsStatus} to copy LocationManager's 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * cached GpsStatus instance to the client's copy. 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void setStatus(GpsSatellite satellite) { 476bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa if (satellite == null) { 486bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa mValid = false; 496bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa } else { 506bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa mValid = satellite.mValid; 516bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa mHasEphemeris = satellite.mHasEphemeris; 526bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa mHasAlmanac = satellite.mHasAlmanac; 536bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa mUsedInFix = satellite.mUsedInFix; 546bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa mSnr = satellite.mSnr; 556bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa mElevation = satellite.mElevation; 566bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa mAzimuth = satellite.mAzimuth; 576bde4683ae1f70f7b5e53f853b6a7479bcebd5d5destradaa } 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the PRN (pseudo-random number) for the satellite. 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return PRN number 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getPrn() { 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPrn; 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the signal to noise ratio for the satellite. 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the signal to noise ratio 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public float getSnr() { 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mSnr; 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the elevation of the satellite in degrees. 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The elevation can vary between 0 and 90. 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the elevation in degrees 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public float getElevation() { 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mElevation; 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the azimuth of the satellite in degrees. 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The azimuth can vary between 0 and 360. 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the azimuth in degrees 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public float getAzimuth() { 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mAzimuth; 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns true if the GPS engine has ephemeris data for the satellite. 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if the satellite has ephemeris data 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean hasEphemeris() { 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mHasEphemeris; 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns true if the GPS engine has almanac data for the satellite. 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if the satellite has almanac data 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean hasAlmanac() { 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mHasAlmanac; 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns true if the satellite was used by the GPS engine when 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * calculating the most recent GPS fix. 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if the satellite was used to compute the most recent fix. 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean usedInFix() { 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mUsedInFix; 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 126