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
|
/*
* 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.Objects;
/**
* Represents an angle of arrival measurement between two devices using Ultra Wideband
*
* @hide
*/
@SystemApi
public final class AngleOfArrivalMeasurement implements Parcelable {
private final AngleMeasurement mAzimuthAngleMeasurement;
private final AngleMeasurement mAltitudeAngleMeasurement;
private AngleOfArrivalMeasurement(@NonNull AngleMeasurement azimuthAngleMeasurement,
@Nullable AngleMeasurement altitudeAngleMeasurement) {
mAzimuthAngleMeasurement = azimuthAngleMeasurement;
mAltitudeAngleMeasurement = altitudeAngleMeasurement;
}
/**
* Azimuth angle measurement
* <p>Azimuth {@link AngleMeasurement} of remote device in horizontal coordinate system, this is
* the angle clockwise from the meridian when viewing above the north pole.
*
* <p>See: https://en.wikipedia.org/wiki/Horizontal_coordinate_system
*
* <p>On an Android device, azimuth north is defined as the angle perpendicular away from the
* back of the device when holding it in portrait mode upright.
*
* <p>Azimuth angle must be supported when Angle of Arrival is supported
*
* @return the azimuth {@link AngleMeasurement}
*/
@NonNull
public AngleMeasurement getAzimuth() {
return mAzimuthAngleMeasurement;
}
/**
* Altitude angle measurement
* <p>Altitude {@link AngleMeasurement} of remote device in horizontal coordinate system, this
* is the angle above the equator when the north pole is up.
*
* <p>See: https://en.wikipedia.org/wiki/Horizontal_coordinate_system
*
* <p>On an Android device, altitude is defined as the angle vertical from ground when holding
* the device in portrait mode upright.
*
* @return altitude {@link AngleMeasurement} or null when this is not available
*/
@Nullable
public AngleMeasurement getAltitude() {
return mAltitudeAngleMeasurement;
}
/**
* @hide
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof AngleOfArrivalMeasurement) {
AngleOfArrivalMeasurement other = (AngleOfArrivalMeasurement) obj;
return mAzimuthAngleMeasurement.equals(other.getAzimuth())
&& mAltitudeAngleMeasurement.equals(other.getAltitude());
}
return false;
}
/**
* @hide
*/
@Override
public int hashCode() {
return Objects.hash(mAzimuthAngleMeasurement, mAltitudeAngleMeasurement);
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(@NonNull Parcel dest, int flags) {
dest.writeParcelable(mAzimuthAngleMeasurement, flags);
dest.writeParcelable(mAltitudeAngleMeasurement, flags);
}
public static final @android.annotation.NonNull Creator<AngleOfArrivalMeasurement> CREATOR =
new Creator<AngleOfArrivalMeasurement>() {
@Override
public AngleOfArrivalMeasurement createFromParcel(Parcel in) {
Builder builder =
new Builder(in.readParcelable(AngleMeasurement.class.getClassLoader()));
builder.setAltitude(in.readParcelable(AngleMeasurement.class.getClassLoader()));
return builder.build();
}
@Override
public AngleOfArrivalMeasurement[] newArray(int size) {
return new AngleOfArrivalMeasurement[size];
}
};
/**
* Builder class for {@link AngleOfArrivalMeasurement}.
*/
public static final class Builder {
private final AngleMeasurement mAzimuthAngleMeasurement;
private AngleMeasurement mAltitudeAngleMeasurement = null;
/**
* Constructs an {@link AngleOfArrivalMeasurement} object
*
* @param azimuthAngle the azimuth angle of the measurement
*/
public Builder(@NonNull AngleMeasurement azimuthAngle) {
mAzimuthAngleMeasurement = azimuthAngle;
}
/**
* Set the altitude angle
*
* @param altitudeAngle altitude angle
*/
@NonNull
public Builder setAltitude(@NonNull AngleMeasurement altitudeAngle) {
mAltitudeAngleMeasurement = altitudeAngle;
return this;
}
/**
* Build the {@link AngleOfArrivalMeasurement} object
*/
@NonNull
public AngleOfArrivalMeasurement build() {
return new AngleOfArrivalMeasurement(mAzimuthAngleMeasurement,
mAltitudeAngleMeasurement);
}
}
}
|
