UwbAddress

class UwbAddress : Parcelable
kotlin.Any
   ↳ android.ranging.uwb.UwbAddress

A class representing a UWB address

Summary

Constants
static Int

static Int

Inherited constants
Public methods
static UwbAddress

Generates a new random 2 bytes UwbAddress.
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
static UwbAddress
fromBytes(address: ByteArray)

Create a android.uwb.UwbAddress from a byte array.
ByteArray

Get the address as a byte array
Int

String

Returns a string representation of the object.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<UwbAddress!>

Constants

EXTENDED_ADDRESS_BYTE_LENGTH

Added in API level Baklava
static val EXTENDED_ADDRESS_BYTE_LENGTH: Int
 
Value: 8

SHORT_ADDRESS_BYTE_LENGTH

Added in API level Baklava
static val SHORT_ADDRESS_BYTE_LENGTH: Int
 
Value: 2

Public methods

createRandomShortAddress

Added in API level Baklava
static fun createRandomShortAddress(): UwbAddress

Generates a new random 2 bytes UwbAddress.

Return
UwbAddress a new randomly generated UwbAddress. This value cannot be null.

describeContents

Added in API level Baklava
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level Baklava
fun equals(other: Any?): Boolean

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
obj This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

fromBytes

Added in API level Baklava
static fun fromBytes(address: ByteArray): UwbAddress

Create a android.uwb.UwbAddress from a byte array.

If the provided array is SHORT_ADDRESS_BYTE_LENGTH bytes, a short address is created. If the provided array is EXTENDED_ADDRESS_BYTE_LENGTH bytes, then an extended address is created.

Parameters
address ByteArray: a byte array to convert to a android.uwb.UwbAddress This value cannot be null.
Return
UwbAddress a android.uwb.UwbAddress created from the input byte array This value cannot be null.
Exceptions
java.lang.IllegalArgumentException when the length is not one of SHORT_ADDRESS_BYTE_LENGTH or EXTENDED_ADDRESS_BYTE_LENGTH bytes

getAddressBytes

Added in API level Baklava
fun getAddressBytes(): ByteArray

Get the address as a byte array

Return
ByteArray the byte representation of this android.uwb.UwbAddress This value cannot be null.

hashCode

Added in API level Baklava
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level Baklava
fun toString(): String

Returns a string representation of the object.

Return
String This value cannot be null.

writeToParcel

Added in API level Baklava
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level Baklava
static val CREATOR: Parcelable.Creator<UwbAddress!>