ResponderLocation
class ResponderLocation : Parcelable
| kotlin.Any | |
| ↳ | android.net.wifi.rtt.ResponderLocation |
ResponderLocation is both a Location Configuration Information (LCI) decoder and a Location Civic Report (LCR) decoder for information received from a Wi-Fi Access Point (AP) during Wi-Fi RTT ranging process.
This is based on the IEEE P802.11-REVmc/D8.0 spec section 9.4.2.22, under Measurement Report Element. Subelement location data-fields parsed from separate input LCI and LCR Information Elements are unified in this class.
Note: The information provided by this class is broadcast by a responder (usually an Access Point), and passed on as-is. There is no guarantee this information is accurate or correct, and as a result developers should carefully consider how this information should be used and provide corresponding advice to users.
Summary
| Constants | |
|---|---|
| static Int |
Responder Altitude is measured in floors. |
| static Int |
Responder Altitude is measured in meters. |
| static Int |
Altitude is not defined for the Responder. |
| static Int |
Datum used is NAD83 MLLW. |
| static Int |
Datum used is NAD83 NAV88. |
| static Int |
Datum is not defined. |
| static Int |
Datum used is WGS84. |
| static Int |
Version of the LCI protocol is 1. |
| static Int |
Location of responder is fixed (does not move) |
| static Int |
Location of the responder is not known to be either fixed or variable. |
| static Int |
Location of the responder status is a reserved value |
| static Int |
Location of the responder is variable, and may move |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int | |
| Boolean | |
| Double | |
| Int | |
| Double | |
| MutableList<MacAddress!>! | |
| Int |
getDatum() |
| Int | |
| Double | |
| Double | |
| Double | |
| Double | |
| Double | |
| Int | |
| Double | |
| Double | |
| String? | |
| Uri? | |
| Boolean | |
| Int |
hashCode() |
| Boolean | |
| Boolean | |
| Address? | |
| SparseArray<String!>? | |
| Location | |
| Unit |
writeToParcel(parcel: Parcel, flags: Int) |
| Properties | |
|---|---|
| static Parcelable.Creator<ResponderLocation!> | |
Constants
ALTITUDE_FLOORS
static val ALTITUDE_FLOORS: Int
Responder Altitude is measured in floors.
Value: 2ALTITUDE_METERS
static val ALTITUDE_METERS: Int
Responder Altitude is measured in meters.
Value: 1ALTITUDE_UNDEFINED
static val ALTITUDE_UNDEFINED: Int
Altitude is not defined for the Responder. The altitude and altitude uncertainty should not be used: see section 2.4 of IETF RFC 6225.
Value: 0DATUM_NAD83_MLLW
static val DATUM_NAD83_MLLW: Int
Datum used is NAD83 MLLW.
Value: 3DATUM_NAD83_NAV88
static val DATUM_NAD83_NAV88: Int
Datum used is NAD83 NAV88.
Value: 2DATUM_UNDEFINED
static val DATUM_UNDEFINED: Int
Datum is not defined.
Value: 0LCI_VERSION_1
static val LCI_VERSION_1: Int
Version of the LCI protocol is 1.0, the only defined protocol at this time.
Value: 1LOCATION_FIXED
static val LOCATION_FIXED: Int
Location of responder is fixed (does not move)
Value: 0LOCATION_MOVEMENT_UNKNOWN
static val LOCATION_MOVEMENT_UNKNOWN: Int
Location of the responder is not known to be either fixed or variable.
Value: 2LOCATION_RESERVED
static val LOCATION_RESERVED: Int
Location of the responder status is a reserved value
Value: 3LOCATION_VARIABLE
static val LOCATION_VARIABLE: Int
Location of the responder is variable, and may move
Value: 1Public methods
describeContents
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
fun equals(other: Any?): Boolean
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getAltitude
fun getAltitude(): Double
| Return | |
|---|---|
Double |
the Altitude in units defined by the altitude type.
Only valid if |
getAltitudeType
fun getAltitudeType(): Int
| Return | |
|---|---|
Int |
the Altitude type.
Only valid if |
getAltitudeUncertainty
fun getAltitudeUncertainty(): Double
| Return | |
|---|---|
Double |
the Altitude uncertainty in meters.
Only valid if An unknown uncertainty is indicated by 0. |
getColocatedBssids
fun getColocatedBssids(): MutableList<MacAddress!>!
| Return | |
|---|---|
MutableList<MacAddress!>! |
the Immutable list of colocated BSSIDs at the responder.
Will return an empty list when there are no bssids listed. |
getDatum
fun getDatum(): Int
| Return | |
|---|---|
Int |
the Datum used for the LCI positioning information.
Only valid if |
getExpectedToMove
fun getExpectedToMove(): Int
| Return | |
|---|---|
Int |
an integer representing the mobility of the responder.
Only valid if |
getFloorNumber
fun getFloorNumber(): Double
| Return | |
|---|---|
Double |
the Z sub element Floor Number.
Only valid if Note: this number can be positive or negative, with value increments of +/- 1/16 of a floor. . |
getHeightAboveFloorMeters
fun getHeightAboveFloorMeters(): Double
| Return | |
|---|---|
Double |
the Z subelement Height above the floor in meters.
Only valid if This value can be positive or negative. |
getHeightAboveFloorUncertaintyMeters
fun getHeightAboveFloorUncertaintyMeters(): Double
| Return | |
|---|---|
Double |
the Z subelement Height above the floor uncertainty in meters.
Only valid if An unknown uncertainty is indicated by 0. |
getLatitude
fun getLatitude(): Double
| Return | |
|---|---|
Double |
the latitude in degrees
Only valid if |
getLatitudeUncertainty
fun getLatitudeUncertainty(): Double
| Return | |
|---|---|
Double |
the latitude uncertainty in degrees.
Only valid if An unknown uncertainty is indicated by 0. |
getLciVersion
fun getLciVersion(): Int
| Return | |
|---|---|
Int |
a value greater or equal to 1, indicating the current version number of the LCI protocol.
Only valid if |
getLongitude
fun getLongitude(): Double
| Return | |
|---|---|
Double |
the Longitude in degrees..
Only valid if |
getLongitudeUncertainty
fun getLongitudeUncertainty(): Double
| Return | |
|---|---|
Double |
the Longitude uncertainty in degrees.
Only valid if An unknown uncertainty is indicated by 0. |
getMapImageMimeType
fun getMapImageMimeType(): String?
| Return | |
|---|---|
String? |
the Map Image file Mime type, referred to by getMapImageUrl(). This value may be null. |
getMapImageUri
fun getMapImageUri(): Uri?
| Return | |
|---|---|
Uri? |
a URI referencing a map-file showing the local floor plan.
Will return a |
getRegisteredLocationAgreementIndication
fun getRegisteredLocationAgreementIndication(): Boolean
| Return | |
|---|---|
Boolean |
true if the station is operating within a national policy area or an international agreement area near a national border, otherwise false (see 802.11REVmc Section 11.12.3 - Registered STA Operation).
Only valid if |
isLciSubelementValid
fun isLciSubelementValid(): Boolean
| Return | |
|---|---|
Boolean |
true if the LCI subelement (containing Latitude, Longitude and Altitude) is valid.
This method tells us if the responder has provided its Location Configuration Information (LCI) directly, and is useful when an external database of responder locations is not available If isLciSubelementValid() returns true, all the LCI values provided by the corresponding getter methods will have been set as described by the responder, or else if false, they should not be used and will throw an IllegalStateException. |
isZaxisSubelementValid
fun isZaxisSubelementValid(): Boolean
| Return | |
|---|---|
Boolean |
if the Z subelement (containing mobility, Floor, Height above floor) is valid. |
toCivicLocationAddress
fun toCivicLocationAddress(): Address?
| Return | |
|---|---|
Address? |
the civic location represented as an Address object (best effort).
Will return a |
toCivicLocationSparseArray
fun toCivicLocationSparseArray(): SparseArray<String!>?
| Return | |
|---|---|
SparseArray<String!>? |
the civic location represented as a SparseArray
Valid keys to access the SparseArray can be found in Will return a |
toLocation
fun toLocation(): Location
| Return | |
|---|---|
Location |
the LCI location represented as a Location object (best effort).
Only valid if |
writeToParcel
fun writeToParcel(
parcel: Parcel,
flags: Int
): Unit
| Parameters | |
|---|---|
dest |
The Parcel in which the object should be written. 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 |