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.
See Summary

Nested classes

class UwbComplexChannel.Builder

Builder for creating instances of UwbComplexChannel. 

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

Added in Android Baklava 
public static final int UWB_CHANNEL_10

UWB channel 10

Constant Value: 10 (0x0000000a)

UWB_CHANNEL_12

Added in Android Baklava 
public static final int UWB_CHANNEL_12

UWB channel 12

Constant Value: 12 (0x0000000c)

UWB_CHANNEL_13

Added in Android Baklava 
public static final int UWB_CHANNEL_13

UWB channel 13

Constant Value: 13 (0x0000000d)

UWB_CHANNEL_14

Added in Android Baklava 
public static final int UWB_CHANNEL_14

UWB channel 14

Constant Value: 14 (0x0000000e)

UWB_CHANNEL_5

Added in Android Baklava 
public static final int UWB_CHANNEL_5

UWB channel 5

Constant Value: 5 (0x00000005)

UWB_CHANNEL_6

Added in Android Baklava 
public static final int UWB_CHANNEL_6

UWB channel 6

Constant Value: 6 (0x00000006)

UWB_CHANNEL_8

Added in Android Baklava 
public static final int UWB_CHANNEL_8

UWB channel 8

Constant Value: 8 (0x00000008)

UWB_CHANNEL_9

Added in Android Baklava 
public static final int UWB_CHANNEL_9

UWB channel 9

Constant Value: 9 (0x00000009)

UWB_PREAMBLE_CODE_INDEX_10

Added in Android Baklava 
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

Added in Android Baklava 
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

Added in Android Baklava 
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

Added in Android Baklava 
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

Added in Android Baklava 
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

Added in Android Baklava 
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

Added in Android Baklava 
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

Added in Android Baklava 
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

Added in Android Baklava 
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

Added in Android Baklava 
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

Added in Android Baklava 
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

Added in Android Baklava 
public static final int UWB_PREAMBLE_CODE_INDEX_9

UWB preamble code index 9 (PRF mode - BPRF).

Constant Value: 9 (0x00000009)

Fields

CREATOR

Added in Android Baklava 
public static final Creator<UwbComplexChannel> CREATOR

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(android.os.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 CONTENTS_FILE_DESCRIPTOR

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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

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: Value is UWB_CHANNEL_5, UWB_CHANNEL_6, UWB_CHANNEL_8, UWB_CHANNEL_9, UWB_CHANNEL_10, UWB_CHANNEL_12, UWB_CHANNEL_13, or UWB_CHANNEL_14

getPreambleIndex

public int getPreambleIndex ()

Gets the UWB preamble index associated with this configuration.

Returns
int The preamble index, which is one of the predefined UWB preamble indices: See UWB_PREAMBLE_CODE_INDEX_9, UWB_PREAMBLE_CODE_INDEX_10, UWB_PREAMBLE_CODE_INDEX_11, UWB_PREAMBLE_CODE_INDEX_12, UWB_PREAMBLE_CODE_INDEX_25, UWB_PREAMBLE_CODE_INDEX_26, UWB_PREAMBLE_CODE_INDEX_27, UWB_PREAMBLE_CODE_INDEX_28, UWB_PREAMBLE_CODE_INDEX_29, UWB_PREAMBLE_CODE_INDEX_30, UWB_PREAMBLE_CODE_INDEX_31, or UWB_PREAMBLE_CODE_INDEX_32

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES