UwbComplexChannel
public
final
class
UwbComplexChannel
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.ranging.uwb.UwbComplexChannel |
A Class representing the complex channel for UWB which comprises channel and preamble index negotiated between peer devices out of band before ranging.
PRF (Pulse Repetition Frequency) supported:
- BPRF - Base Pulse Repetition Frequency.
- HPRF - Higher Pulse Repetition Frequency.
Nested classes | |
|---|---|
class |
UwbComplexChannel.Builder
Builder for creating instances of |
Constants | |
|---|---|
int |
UWB_CHANNEL_10
UWB channel 10 |
int |
UWB_CHANNEL_12
UWB channel 12 |
int |
UWB_CHANNEL_13
UWB channel 13 |
int |
UWB_CHANNEL_14
UWB channel 14 |
int |
UWB_CHANNEL_5
UWB channel 5 |
int |
UWB_CHANNEL_6
UWB channel 6 |
int |
UWB_CHANNEL_8
UWB channel 8 |
int |
UWB_CHANNEL_9
UWB channel 9 |
int |
UWB_PREAMBLE_CODE_INDEX_10
UWB preamble code index 10 (PRF mode - BPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_11
UWB preamble code index 11 (PRF mode - BPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_12
UWB preamble code index 12 (PRF mode - BPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_25
UWB preamble code index 25 (PRF mode - HPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_26
UWB preamble code index 26 (PRF mode - HPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_27
UWB preamble code index 27 (PRF mode - HPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_28
UWB preamble code index 28 (PRF mode - HPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_29
UWB preamble code index 29 (PRF mode - HPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_30
UWB preamble code index 30 (PRF mode - HPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_31
UWB preamble code index 31 (PRF mode - HPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_32
UWB preamble code index 32 (PRF mode - HPRF). |
int |
UWB_PREAMBLE_CODE_INDEX_9
UWB preamble code index 9 (PRF mode - BPRF). |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<UwbComplexChannel> |
CREATOR
|
Public methods | |
|---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
int
|
getChannel()
Gets the UWB channel associated with this configuration. |
int
|
getPreambleIndex()
Gets the UWB preamble index associated with this configuration. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Constants
UWB_CHANNEL_10
public static final int UWB_CHANNEL_10
UWB channel 10
Constant Value: 10 (0x0000000a)
UWB_CHANNEL_12
public static final int UWB_CHANNEL_12
UWB channel 12
Constant Value: 12 (0x0000000c)
UWB_CHANNEL_13
public static final int UWB_CHANNEL_13
UWB channel 13
Constant Value: 13 (0x0000000d)
UWB_CHANNEL_14
public static final int UWB_CHANNEL_14
UWB channel 14
Constant Value: 14 (0x0000000e)
UWB_CHANNEL_5
public static final int UWB_CHANNEL_5
UWB channel 5
Constant Value: 5 (0x00000005)
UWB_CHANNEL_6
public static final int UWB_CHANNEL_6
UWB channel 6
Constant Value: 6 (0x00000006)
UWB_CHANNEL_8
public static final int UWB_CHANNEL_8
UWB channel 8
Constant Value: 8 (0x00000008)
UWB_CHANNEL_9
public static final int UWB_CHANNEL_9
UWB channel 9
Constant Value: 9 (0x00000009)
UWB_PREAMBLE_CODE_INDEX_10
public static final int UWB_PREAMBLE_CODE_INDEX_10
UWB preamble code index 10 (PRF mode - BPRF).
Constant Value: 10 (0x0000000a)
UWB_PREAMBLE_CODE_INDEX_11
public static final int UWB_PREAMBLE_CODE_INDEX_11
UWB preamble code index 11 (PRF mode - BPRF).
Constant Value: 11 (0x0000000b)
UWB_PREAMBLE_CODE_INDEX_12
public static final int UWB_PREAMBLE_CODE_INDEX_12
UWB preamble code index 12 (PRF mode - BPRF).
Constant Value: 12 (0x0000000c)
UWB_PREAMBLE_CODE_INDEX_25
public static final int UWB_PREAMBLE_CODE_INDEX_25
UWB preamble code index 25 (PRF mode - HPRF).
Constant Value: 25 (0x00000019)
UWB_PREAMBLE_CODE_INDEX_26
public static final int UWB_PREAMBLE_CODE_INDEX_26
UWB preamble code index 26 (PRF mode - HPRF).
Constant Value: 26 (0x0000001a)
UWB_PREAMBLE_CODE_INDEX_27
public static final int UWB_PREAMBLE_CODE_INDEX_27
UWB preamble code index 27 (PRF mode - HPRF).
Constant Value: 27 (0x0000001b)
UWB_PREAMBLE_CODE_INDEX_28
public static final int UWB_PREAMBLE_CODE_INDEX_28
UWB preamble code index 28 (PRF mode - HPRF).
Constant Value: 28 (0x0000001c)
UWB_PREAMBLE_CODE_INDEX_29
public static final int UWB_PREAMBLE_CODE_INDEX_29
UWB preamble code index 29 (PRF mode - HPRF).
Constant Value: 29 (0x0000001d)
UWB_PREAMBLE_CODE_INDEX_30
public static final int UWB_PREAMBLE_CODE_INDEX_30
UWB preamble code index 30 (PRF mode - HPRF).
Constant Value: 30 (0x0000001e)
UWB_PREAMBLE_CODE_INDEX_31
public static final int UWB_PREAMBLE_CODE_INDEX_31
UWB preamble code index 31 (PRF mode - HPRF).
Constant Value: 31 (0x0000001f)
UWB_PREAMBLE_CODE_INDEX_32
public static final int UWB_PREAMBLE_CODE_INDEX_32
UWB preamble code index 32 (PRF mode - HPRF).
Constant Value: 32 (0x00000020)
UWB_PREAMBLE_CODE_INDEX_9
public static final int UWB_PREAMBLE_CODE_INDEX_9
UWB preamble code index 9 (PRF mode - BPRF).
Constant Value: 9 (0x00000009)
Fields
Public methods
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(Parcel,int),
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR bit.
| Returns | |
|---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or
|
equals
public boolean equals (Object o)
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
o |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getChannel
public int getChannel ()
Gets the UWB channel associated with this configuration.
| Returns | |
|---|---|
int |
The channel number, which is one of the predefined UWB channels: |
getPreambleIndex
public int getPreambleIndex ()
Gets the UWB preamble index associated with this configuration.