src.android.location.GnssMeasurementRequest Maven / Gradle / Ivy
Show all versions of android-all Show documentation
/*
* Copyright (C) 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.location;
import android.annotation.NonNull;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;
import java.util.Objects;
/**
* This class contains extra parameters to pass in a GNSS measurement request.
*/
public final class GnssMeasurementRequest implements Parcelable {
private final boolean mCorrelationVectorOutputsEnabled;
private final boolean mFullTracking;
/**
* Creates a {@link GnssMeasurementRequest} with a full list of parameters.
*/
private GnssMeasurementRequest(boolean fullTracking, boolean correlationVectorOutputsEnabled) {
mFullTracking = fullTracking;
mCorrelationVectorOutputsEnabled = correlationVectorOutputsEnabled;
}
/**
* Represents whether to enable correlation vector outputs.
*
* If true, enable correlation vectors as part of the raw GNSS measurements outputs.
* If false, disable correlation vectors.
*
* @hide
*/
@SystemApi
public boolean isCorrelationVectorOutputsEnabled() {
return mCorrelationVectorOutputsEnabled;
}
/**
* Represents whether to enable full GNSS tracking.
*
*
If true, GNSS chipset switches off duty cycling. In such a mode, no clock
* discontinuities are expected, and when supported, carrier phase should be continuous in
* good signal conditions. All non-blocklisted, healthy constellations, satellites and
* frequency bands that the chipset supports must be reported in this mode. The GNSS chipset
* will consume more power in full tracking mode than in duty cycling mode. If false, GNSS
* chipset optimizes power via duty cycling, constellations and frequency limits, etc.
*
*
Full GNSS tracking mode affects GnssMeasurement and other GNSS functionalities
* including GNSS location.
*/
public boolean isFullTracking() {
return mFullTracking;
}
@NonNull
public static final Creator CREATOR =
new Creator() {
@Override
@NonNull
public GnssMeasurementRequest createFromParcel(@NonNull Parcel parcel) {
return new GnssMeasurementRequest(parcel.readBoolean(), parcel.readBoolean());
}
@Override
public GnssMeasurementRequest[] newArray(int i) {
return new GnssMeasurementRequest[i];
}
};
@Override
public void writeToParcel(@NonNull Parcel parcel, int flags) {
parcel.writeBoolean(mFullTracking);
parcel.writeBoolean(mCorrelationVectorOutputsEnabled);
}
@NonNull
@Override
public String toString() {
StringBuilder s = new StringBuilder();
s.append("GnssMeasurementRequest[");
if (mFullTracking) {
s.append("FullTracking");
}
if (mCorrelationVectorOutputsEnabled) {
s.append(", CorrelationVectorOutPuts");
}
s.append(']');
return s.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (!(obj instanceof GnssMeasurementRequest)) return false;
GnssMeasurementRequest other = (GnssMeasurementRequest) obj;
if (mFullTracking != other.mFullTracking) return false;
if (mCorrelationVectorOutputsEnabled != other.mCorrelationVectorOutputsEnabled) {
return false;
}
return true;
}
@Override
public int hashCode() {
return Objects.hash(mFullTracking, mCorrelationVectorOutputsEnabled);
}
@Override
public int describeContents() {
return 0;
}
/** Builder for {@link GnssMeasurementRequest} */
public static final class Builder {
private boolean mCorrelationVectorOutputsEnabled;
private boolean mFullTracking;
/**
* Constructs a {@link Builder} instance.
*/
public Builder() {
}
/**
* Constructs a {@link Builder} instance by copying a {@link GnssMeasurementRequest}.
*/
public Builder(@NonNull GnssMeasurementRequest request) {
mCorrelationVectorOutputsEnabled = request.isCorrelationVectorOutputsEnabled();
mFullTracking = request.isFullTracking();
}
/**
* Set the value of whether to enable correlation vector outputs, which is false by default.
*
* If true, enable correlation vectors as part of the raw GNSS measurements outputs.
* If false, disable correlation vectors.
*
* @hide
*/
@SystemApi
@NonNull public Builder setCorrelationVectorOutputsEnabled(boolean value) {
mCorrelationVectorOutputsEnabled = value;
return this;
}
/**
* Set the value of whether to enable full GNSS tracking, which is false by default.
*
*
If true, GNSS chipset switches off duty cycling. In such a mode, no clock
* discontinuities are expected, and when supported, carrier phase should be continuous in
* good signal conditions. All non-blocklisted, healthy constellations, satellites and
* frequency bands that the chipset supports must be reported in this mode. The GNSS chipset
* will consume more power in full tracking mode than in duty cycling mode. If false,
* GNSS chipset optimizes power via duty cycling, constellations and frequency limits, etc.
*
*
Full GNSS tracking mode affects GnssMeasurement and other GNSS functionalities
* including GNSS location.
*
*
Full tracking requests always override non-full tracking requests. If any full
* tracking request occurs, all listeners on the device will receive full tracking GNSS
* measurements.
*/
@NonNull public Builder setFullTracking(boolean value) {
mFullTracking = value;
return this;
}
/** Builds a {@link GnssMeasurementRequest} instance as specified by this builder. */
@NonNull
public GnssMeasurementRequest build() {
return new GnssMeasurementRequest(mFullTracking, mCorrelationVectorOutputsEnabled);
}
}
}