1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*
* Copyright 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.uwb;
import android.annotation.FloatRange;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;
import java.util.Objects;
/**
* A data point for the distance measurement
*
* <p>The actual distance is interpreted as:
* {@link #getMeters()} +/- {@link #getErrorMeters()} at {@link #getConfidenceLevel()}
*
* @hide
*/
@SystemApi
public final class DistanceMeasurement implements Parcelable {
private final double mMeters;
private final double mErrorMeters;
private final double mConfidenceLevel;
private DistanceMeasurement(double meters, double errorMeters, double confidenceLevel) {
mMeters = meters;
mErrorMeters = errorMeters;
mConfidenceLevel = confidenceLevel;
}
/**
* Distance measurement in meters
*
* @return distance in meters
*/
public double getMeters() {
return mMeters;
}
/**
* Error of distance measurement in meters
* <p>Must be positive
*
* @return error of distance measurement in meters
*/
@FloatRange(from = 0.0)
public double getErrorMeters() {
return mErrorMeters;
}
/**
* Distance measurement confidence level expressed as a value between 0.0 to 1.0.
*
* <p>A value of 0.0 indicates no confidence in the measurement. A value of 1.0 represents
* maximum confidence in the measurement
*
* @return confidence level
*/
@FloatRange(from = 0.0, to = 1.0)
public double getConfidenceLevel() {
return mConfidenceLevel;
}
/**
* @hide
*/
@Override
public boolean equals(@Nullable Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof DistanceMeasurement) {
DistanceMeasurement other = (DistanceMeasurement) obj;
return mMeters == other.getMeters()
&& mErrorMeters == other.getErrorMeters()
&& mConfidenceLevel == other.getConfidenceLevel();
}
return false;
}
/**
* @hide
*/
@Override
public int hashCode() {
return Objects.hash(mMeters, mErrorMeters, mConfidenceLevel);
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(@NonNull Parcel dest, int flags) {
dest.writeDouble(mMeters);
dest.writeDouble(mErrorMeters);
dest.writeDouble(mConfidenceLevel);
}
public static final @android.annotation.NonNull Creator<DistanceMeasurement> CREATOR =
new Creator<DistanceMeasurement>() {
@Override
public DistanceMeasurement createFromParcel(Parcel in) {
Builder builder = new Builder();
builder.setMeters(in.readDouble());
builder.setErrorMeters(in.readDouble());
builder.setConfidenceLevel(in.readDouble());
return builder.build();
}
@Override
public DistanceMeasurement[] newArray(int size) {
return new DistanceMeasurement[size];
}
};
/**
* Builder to get a {@link DistanceMeasurement} object.
*/
public static final class Builder {
private double mMeters = Double.NaN;
private double mErrorMeters = Double.NaN;
private double mConfidenceLevel = Double.NaN;
/**
* Set the distance measurement in meters
*
* @param meters distance in meters
* @throws IllegalArgumentException if meters is NaN
*/
@NonNull
public Builder setMeters(double meters) {
if (Double.isNaN(meters)) {
throw new IllegalArgumentException("meters cannot be NaN");
}
mMeters = meters;
return this;
}
/**
* Set the distance error in meters
*
* @param errorMeters distance error in meters
* @throws IllegalArgumentException if error is negative or NaN
*/
@NonNull
public Builder setErrorMeters(@FloatRange(from = 0.0) double errorMeters) {
if (Double.isNaN(errorMeters) || errorMeters < 0.0) {
throw new IllegalArgumentException(
"errorMeters must be >= 0.0 and not NaN: " + errorMeters);
}
mErrorMeters = errorMeters;
return this;
}
/**
* Set the confidence level
*
* @param confidenceLevel the confidence level in the distance measurement
* @throws IllegalArgumentException if confidence level is not in the range of [0.0, 1.0]
*/
@NonNull
public Builder setConfidenceLevel(
@FloatRange(from = 0.0, to = 1.0) double confidenceLevel) {
if (confidenceLevel < 0.0 || confidenceLevel > 1.0) {
throw new IllegalArgumentException(
"confidenceLevel must be in the range [0.0, 1.0]: " + confidenceLevel);
}
mConfidenceLevel = confidenceLevel;
return this;
}
/**
* Builds the {@link DistanceMeasurement} object
*
* @throws IllegalStateException if meters, error, or confidence are not set
*/
@NonNull
public DistanceMeasurement build() {
if (Double.isNaN(mMeters)) {
throw new IllegalStateException("Meters cannot be NaN");
}
if (Double.isNaN(mErrorMeters)) {
throw new IllegalStateException("Error meters cannot be NaN");
}
if (Double.isNaN(mConfidenceLevel)) {
throw new IllegalStateException("Confidence level cannot be NaN");
}
return new DistanceMeasurement(mMeters, mErrorMeters, mConfidenceLevel);
}
}
}
|
