blob: 7a2df86177004901ec7bdbbf1442af28508583de (
plain)
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
|
/*
* 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.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
/**
* This class contains the UWB ranging data
*
* @hide
*/
@SystemApi
public final class RangingReport implements Parcelable {
private final List<RangingMeasurement> mRangingMeasurements;
private RangingReport(@NonNull List<RangingMeasurement> rangingMeasurements) {
mRangingMeasurements = rangingMeasurements;
}
/**
* Get a {@link List} of {@link RangingMeasurement} objects in the last measurement interval
* <p>The underlying UWB adapter may choose to do multiple measurements in each ranging
* interval.
*
* <p>The entries in the {@link List} are ordered in ascending order based on
* {@link RangingMeasurement#getElapsedRealtimeNanos()}
*
* @return a {@link List} of {@link RangingMeasurement} objects
*/
@NonNull
public List<RangingMeasurement> getMeasurements() {
return mRangingMeasurements;
}
/**
* @hide
*/
@Override
public boolean equals(@Nullable Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof RangingReport) {
RangingReport other = (RangingReport) obj;
return mRangingMeasurements.equals(other.getMeasurements());
}
return false;
}
/**
* @hide
*/
@Override
public int hashCode() {
return Objects.hash(mRangingMeasurements);
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(@NonNull Parcel dest, int flags) {
dest.writeTypedList(mRangingMeasurements);
}
public static final @android.annotation.NonNull Creator<RangingReport> CREATOR =
new Creator<RangingReport>() {
@Override
public RangingReport createFromParcel(Parcel in) {
Builder builder = new Builder();
builder.addMeasurements(in.createTypedArrayList(RangingMeasurement.CREATOR));
return builder.build();
}
@Override
public RangingReport[] newArray(int size) {
return new RangingReport[size];
}
};
/**
* Builder for {@link RangingReport} object
*/
public static final class Builder {
List<RangingMeasurement> mMeasurements = new ArrayList<>();
/**
* Add a single {@link RangingMeasurement}
*
* @param rangingMeasurement a ranging measurement
*/
@NonNull
public Builder addMeasurement(@NonNull RangingMeasurement rangingMeasurement) {
mMeasurements.add(rangingMeasurement);
return this;
}
/**
* Add a {@link List} of {@link RangingMeasurement}s
*
* @param rangingMeasurements {@link List} of {@link RangingMeasurement}s to add
*/
@NonNull
public Builder addMeasurements(@NonNull List<RangingMeasurement> rangingMeasurements) {
mMeasurements.addAll(rangingMeasurements);
return this;
}
/**
* Build the {@link RangingReport} object
*
* @throws IllegalStateException if measurements are not in monotonically increasing order
*/
@NonNull
public RangingReport build() {
// Verify that all measurement timestamps are monotonically increasing
RangingMeasurement prevMeasurement = null;
for (int curIndex = 0; curIndex < mMeasurements.size(); curIndex++) {
RangingMeasurement curMeasurement = mMeasurements.get(curIndex);
if (prevMeasurement != null
&& (prevMeasurement.getElapsedRealtimeNanos()
> curMeasurement.getElapsedRealtimeNanos())) {
throw new IllegalStateException(
"Timestamp (" + curMeasurement.getElapsedRealtimeNanos()
+ ") at index " + curIndex + " is less than previous timestamp ("
+ prevMeasurement.getElapsedRealtimeNanos() + ")");
}
prevMeasurement = curMeasurement;
}
return new RangingReport(mMeasurements);
}
}
}
|