# Print output for @column tags ?>
public
final
class
ResponderLocation
extends Object
implements
Parcelable
java.lang.Object | |
↳ | 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.
Constants | |
---|---|
int |
ALTITUDE_FLOORS
Responder Altitude is measured in floors. |
int |
ALTITUDE_METERS
Responder Altitude is measured in meters. |
int |
ALTITUDE_UNDEFINED
Altitude is not defined for the Responder. |
int |
DATUM_NAD83_MLLW
Datum used is NAD83 MLLW. |
int |
DATUM_NAD83_NAV88
Datum used is NAD83 NAV88. |
int |
DATUM_UNDEFINED
Datum is not defined. |
int |
DATUM_WGS84
Datum used is WGS84. |
int |
LCI_VERSION_1
Version of the LCI protocol is 1.0, the only defined protocol at this time. |
int |
LOCATION_FIXED
Location of responder is fixed (does not move) |
int |
LOCATION_MOVEMENT_UNKNOWN
Location of the responder is not known to be either fixed or variable. |
int |
LOCATION_RESERVED
Location of the responder status is a reserved value |
int |
LOCATION_VARIABLE
Location of the responder is variable, and may move |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<ResponderLocation> |
CREATOR
|
Inherited methods | |
---|---|
public static final int ALTITUDE_FLOORS
Responder Altitude is measured in floors.
Constant Value: 2 (0x00000002)
public static final int ALTITUDE_METERS
Responder Altitude is measured in meters.
Constant Value: 1 (0x00000001)
public static final int ALTITUDE_UNDEFINED
Altitude is not defined for the Responder. The altitude and altitude uncertainty should not be used: see section 2.4 of IETF RFC 6225.
Constant Value: 0 (0x00000000)
public static final int DATUM_NAD83_MLLW
Datum used is NAD83 MLLW.
Constant Value: 3 (0x00000003)
public static final int DATUM_NAD83_NAV88
Datum used is NAD83 NAV88.
Constant Value: 2 (0x00000002)
public static final int DATUM_UNDEFINED
Datum is not defined.
Constant Value: 0 (0x00000000)
public static final int DATUM_WGS84
Datum used is WGS84.
Constant Value: 1 (0x00000001)
public static final int LCI_VERSION_1
Version of the LCI protocol is 1.0, the only defined protocol at this time.
Constant Value: 1 (0x00000001)
public static final int LOCATION_FIXED
Location of responder is fixed (does not move)
Constant Value: 0 (0x00000000)
public static final int LOCATION_MOVEMENT_UNKNOWN
Location of the responder is not known to be either fixed or variable.
Constant Value: 2 (0x00000002)
public static final int LOCATION_RESERVED
Location of the responder status is a reserved value
Constant Value: 3 (0x00000003)
public static final int LOCATION_VARIABLE
Location of the responder is variable, and may move
Constant Value: 1 (0x00000001)
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 |
public boolean equals (Object obj)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
Parameters | |
---|---|
obj |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public double getAltitude ()
Returns | |
---|---|
double |
the Altitude in units defined by the altitude type.
Only valid if |
public int getAltitudeType ()
Returns | |
---|---|
int |
the Altitude type.
Only valid if |
public double getAltitudeUncertainty ()
Returns | |
---|---|
double |
the Altitude uncertainty in meters.
Only valid if An unknown uncertainty is indicated by 0. |
public List<MacAddress> getColocatedBssids ()
Returns | |
---|---|
List<MacAddress> |
the Immutable list of colocated BSSIDs at the responder.
Will return an empty list when there are no bssids listed. |
public int getDatum ()
Returns | |
---|---|
int |
the Datum used for the LCI positioning information.
Only valid if |
public int getExpectedToMove ()
Returns | |
---|---|
int |
an integer representing the mobility of the responder.
Only valid if |
public double getFloorNumber ()
Returns | |
---|---|
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. . |
public double getHeightAboveFloorMeters ()
Returns | |
---|---|
double |
the Z subelement Height above the floor in meters.
Only valid if This value can be positive or negative. |
public double getHeightAboveFloorUncertaintyMeters ()
Returns | |
---|---|
double |
the Z subelement Height above the floor uncertainty in meters.
Only valid if An unknown uncertainty is indicated by 0. |
public double getLatitude ()
Returns | |
---|---|
double |
the latitude in degrees
Only valid if |
public double getLatitudeUncertainty ()
Returns | |
---|---|
double |
the latitude uncertainty in degrees.
Only valid if An unknown uncertainty is indicated by 0. |
public int getLciVersion ()
Returns | |
---|---|
int |
a value greater or equal to 1, indicating the current version number
of the LCI protocol.
Only valid if |
public double getLongitude ()
Returns | |
---|---|
double |
the Longitude in degrees..
Only valid if |
public double getLongitudeUncertainty ()
Returns | |
---|---|
double |
the Longitude uncertainty in degrees.
Only valid if An unknown uncertainty is indicated by 0. |
public String getMapImageMimeType ()
Returns | |
---|---|
String |
the Map Image file Mime type, referred to by getMapImageUrl().
This value may be null . |
public Uri getMapImageUri ()
Returns | |
---|---|
Uri |
a URI referencing a map-file showing the local floor plan.
Will return a |
public boolean getRegisteredLocationAgreementIndication ()
Returns | |
---|---|
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 |
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:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
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.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
public boolean isLciSubelementValid ()
Returns | |
---|---|
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. |
public boolean isZaxisSubelementValid ()
Returns | |
---|---|
boolean |
if the Z subelement (containing mobility, Floor, Height above floor) is valid. |
public Address toCivicLocationAddress ()
Returns | |
---|---|
Address |
the civic location represented as an Address object (best effort).
Will return a |
public SparseArray<String> toCivicLocationSparseArray ()
Returns | |
---|---|
SparseArray<String> |
the civic location represented as a SparseArray
Valid keys to access the SparseArray can be found in Will return a |
public Location toLocation ()
Returns | |
---|---|
Location |
the LCI location represented as a Location object (best effort).
Only valid if |
public void writeToParcel (Parcel parcel, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
parcel |
Parcel : The Parcel in which the object should be written. |
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 |