Update GnssAntennaInfo docs and formatting (8f0b3f26) · Commits · e / os / android_frameworks_base

location/java/android/location/GnssAntennaInfo.java

+77 −30

Original line number	Diff line number	Diff line
		@@ -95,31 +95,55 @@ public final class GnssAntennaInfo implements Parcelable {
		}
		};

		/**
		* Returns the x-axis offset of the phase center from the origin of the Android sensor
		* coordinate system, in millimeters.
		*/
		@FloatRange()
		public double getXOffsetMm() {
		return mOffsetXMm;
		}

		/**
		* Returns the 1-sigma uncertainty of the x-axis offset of the phase center from the origin
		* of the Android sensor coordinate system, in millimeters.
		*/
		@FloatRange()
		public double getXOffsetUncertaintyMm() {
		return mOffsetXUncertaintyMm;
		}

		/**
		* Returns the y-axis offset of the phase center from the origin of the Android sensor
		* coordinate system, in millimeters.
		*/
		@FloatRange()
		public double getYOffsetMm() {
		return mOffsetYMm;
		}

		/**
		* Returns the 1-sigma uncertainty of the y-axis offset of the phase center from the origin
		* of the Android sensor coordinate system, in millimeters.
		*/
		@FloatRange()
		public double getYOffsetUncertaintyMm() {
		return mOffsetYUncertaintyMm;
		}

		/**
		* Returns the z-axis offset of the phase center from the origin of the Android sensor
		* coordinate system, in millimeters.
		*/
		@FloatRange()
		public double getZOffsetMm() {
		return mOffsetZMm;
		}

		/**
		* Returns the 1-sigma uncertainty of the z-axis offset of the phase center from the origin
		* of the Android sensor coordinate system, in millimeters.
		*/
		@FloatRange()
		public double getZOffsetUncertaintyMm() {
		return mOffsetZUncertaintyMm;
		@@ -340,6 +364,7 @@ public final class GnssAntennaInfo implements Parcelable {

		/**
		* Set antenna carrier frequency (MHz).
		*
		* @param carrierFrequencyMHz antenna carrier frequency (MHz)
		* @return Builder builder object
		*/
		@@ -351,6 +376,7 @@ public final class GnssAntennaInfo implements Parcelable {

		/**
		* Set antenna phase center offset.
		*
		* @param phaseCenterOffset phase center offset object
		* @return Builder builder object
		*/
		@@ -362,6 +388,7 @@ public final class GnssAntennaInfo implements Parcelable {

		/**
		* Set phase center variation corrections.
		*
		* @param phaseCenterVariationCorrections phase center variation corrections object
		* @return Builder builder object
		*/
		@@ -374,6 +401,7 @@ public final class GnssAntennaInfo implements Parcelable {

		/**
		* Set signal gain corrections.
		*
		* @param signalGainCorrections signal gain corrections object
		* @return Builder builder object
		*/
		@@ -386,6 +414,7 @@ public final class GnssAntennaInfo implements Parcelable {

		/**
		* Build GnssAntennaInfo object.
		*
		* @return instance of GnssAntennaInfo
		*/
		@NonNull
		@@ -400,23 +429,41 @@ public final class GnssAntennaInfo implements Parcelable {
		return mCarrierFrequencyMHz;
		}

		/**
		* Returns a {@link PhaseCenterOffset} object encapsulating the phase center offset and
		* corresponding uncertainties in millimeters.
		*
		* @return {@link PhaseCenterOffset}
		*/
		@NonNull
		public PhaseCenterOffset getPhaseCenterOffset() {
		return mPhaseCenterOffset;
		}

		/**
		* Returns a {@link SphericalCorrections} object encapsulating the phase center variation
		* corrections and corresponding uncertainties in millimeters.
		*
		* @return phase center variation corrections as {@link SphericalCorrections}
		*/
		@Nullable
		public SphericalCorrections getPhaseCenterVariationCorrections() {
		return mPhaseCenterVariationCorrections;
		}

		/**
		* Returns a {@link SphericalCorrections} object encapsulating the signal gain
		* corrections and corresponding uncertainties in dBi.
		*
		* @return signal gain corrections as {@link SphericalCorrections}
		*/
		@Nullable
		public SphericalCorrections getSignalGainCorrections() {
		return mSignalGainCorrections;
		}

		public static final @android.annotation.NonNull
		Creator<GnssAntennaInfo> CREATOR = new Creator<GnssAntennaInfo>() {
		public static final @android.annotation.NonNull Creator<GnssAntennaInfo> CREATOR =
		new Creator<GnssAntennaInfo>() {
		@Override
		public GnssAntennaInfo createFromParcel(Parcel in) {
		double carrierFrequencyMHz = in.readDouble();