IALocation (IndoorAtlas Android SDK 2.3.2)

java.lang.Object
- com.indooratlas.android.sdk.IALocation

All Implemented Interfaces:

Parcelable
```
public class IALocation
extends Object
implements Parcelable
```
A data object representing a geographic location.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IALocation.Builder
Builder to configure IALocation.
- Nested classes/interfaces inherited from interface android.os.Parcelable
  Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`IALocation.Builder` Builder to configure `IALocation`.

Field Summary

Fields
Modifier and Type	Field and Description
`static Parcelable.Creator<IALocation>`	`CREATOR`
`static String`	`EXTRA_FLOOR_CERTAINTY` Key used when storing floor level information under `Location.getExtras()`.
`static String`	`EXTRA_FLOOR_LEVEL` Key used when storing floor level information under `Location.getExtras()`.
`static String`	`EXTRA_REGION` Key used when storing region information under `Location.getExtras()`.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors
Modifier Constructor and Description

protected IALocation(Parcel in)
Do not use this constructor directly.

Constructors
Modifier	Constructor and Description
`protected`	`IALocation(Parcel in)` Do not use this constructor directly.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`describeContents()`
`boolean`	`equals(Object o)`
`static IALocation`	`from(IARegion region)` Convenience method to construct `IALocation` object based on given `IARegion`.
`static IALocation`	`from(Location location)` Convenience method to construct `IALocation` object from properties in a platform `location`.
`float`	`getAccuracy()` Returns location accuracy in meters.
`double`	`getAltitude()` Returns altitude in meters, or `0.0` if not available.
`float`	`getBearing()` Returns bearing in degrees, in range of `(0.0, 360.0]`.
`float`	`getFloorCertainty()` The certainty of the floor selection between 0 and 1.
`int`	`getFloorLevel()` The logical floor level of building.
`double`	`getLatitude()` Returns latitude in degrees.
`double`	`getLongitude()` Returns longitude in degrees.
`IARegion`	`getRegion()` Returns region information from which this location was produced from.
`long`	`getTime()` Returns UTC time of this location fix.
`boolean`	`hasFloorCertainty()` Returns `true` if this location fix had floor certainty information.
`boolean`	`hasFloorLevel()` Returns `true` if this location fix had floor level information.
`int`	`hashCode()`
`IALocation.Builder`	`newBuilder()`
`Location`	`toLocation()` Returns a platform location representing the same coordinate location as `this` instance.
`String`	`toString()`
`void`	`writeToParcel(Parcel dest, int flags)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EXTRA_REGION
```
public static final String EXTRA_REGION
```
    Key used when storing region information under Location.getExtras().
    
    See Also:
    
    toLocation(), Constant Field Values
  - EXTRA_FLOOR_LEVEL
```
public static final String EXTRA_FLOOR_LEVEL
```
    Key used when storing floor level information under Location.getExtras().
    
    See Also:
    
    toLocation(), Constant Field Values
  - EXTRA_FLOOR_CERTAINTY
```
public static final String EXTRA_FLOOR_CERTAINTY
```
    Key used when storing floor level information under Location.getExtras().
    
    See Also:
    
    toLocation(), Constant Field Values
  - CREATOR
```
public static final Parcelable.Creator<IALocation> CREATOR
```
- Constructor Detail
  - IALocation
```
protected IALocation(Parcel in)
```
    Do not use this constructor directly.
- Method Detail
  - newBuilder
```
public IALocation.Builder newBuilder()
```
    Returns:
    
    IALocation.Builder pre-populated with values from this location.
  - from
```
public static IALocation from(Location location)
```
    Convenience method to construct IALocation object from properties in a platform location. The returned IALocation can be used e.g. with IALocationManager.setLocation(IALocation)
    
    Returns:
    
    new IALocation object populated with values read from location
    
    See Also:
    
    IALocationManager.setLocation(IALocation)
  - from
```
public static IALocation from(IARegion region)
```
    Convenience method to construct IALocation object based on given IARegion. The returned IALocation can be used e.g. with IALocationManager.setLocation(IALocation).
    
    Returns:
    
    new IALocation object populated with region set to given region.
    
    See Also:
    
    IALocationManager.setLocation(IALocation)
  - toLocation
```
public Location toLocation()
```
    Returns a platform location representing the same coordinate location as this instance.
    IndoorAtlas specific attributes that the regular Location does not express, such as floor level and region are stored under extra bundle returned by Location.getExtras(). See EXTRA_XXX constants in this class.
    
    Returns:
    
    new Location instance representing this object
  - getLatitude
```
public double getLatitude()
```
    Returns latitude in degrees.
  - getLongitude
```
public double getLongitude()
```
    Returns longitude in degrees.
  - getBearing
```
public float getBearing()
```
    Returns bearing in degrees, in range of (0.0, 360.0]. North is 0 degrees, east 90 degrees and so on.
  - getAccuracy
```
public float getAccuracy()
```
    Returns location accuracy in meters.
  - getTime
```
public long getTime()
```
    Returns UTC time of this location fix.
  - getAltitude
```
public double getAltitude()
```
    Returns altitude in meters, or 0.0 if not available.
  - hasFloorLevel
```
public boolean hasFloorLevel()
```
    Returns true if this location fix had floor level information.
    
    See Also:
    
    getFloorLevel(), hasFloorCertainty(), getFloorCertainty()
  - getFloorLevel
```
public int getFloorLevel()
```
    The logical floor level of building. Does not always match with numbering scheme of floors used in building. Ground level is 0. Levels below the ground are represent with negative integers. First underground level is -1. Levels above the ground are represent with positive integers. First level above ground level is 1.Returns floor level or 0 if information not available.
    
    See Also:
    
    hasFloorLevel(), hasFloorCertainty(), getFloorCertainty()
  - hasFloorCertainty
```
public boolean hasFloorCertainty()
```
    Returns true if this location fix had floor certainty information.
    
    See Also:
    
    hasFloorLevel(), getFloorLevel(), getFloorCertainty()
  - getFloorCertainty
```
public float getFloorCertainty()
```
    The certainty of the floor selection between 0 and 1. Returns 0 if information not available.
    
    See Also:
    
    hasFloorLevel(), getFloorLevel(), hasFloorCertainty()
  - getRegion
```
public IARegion getRegion()
```
    Returns region information from which this location was produced from.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - writeToParcel
```
public void writeToParcel(Parcel dest,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface Parcelable
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface Parcelable

Class IALocation

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTRA_REGION

EXTRA_FLOOR_LEVEL

EXTRA_FLOOR_CERTAINTY

CREATOR

Constructor Detail

IALocation

Method Detail

newBuilder

from

from

toLocation

getLatitude

getLongitude

getBearing

getAccuracy

getTime

getAltitude

hasFloorLevel

getFloorLevel

hasFloorCertainty

getFloorCertainty

getRegion

equals

hashCode

toString

writeToParcel

describeContents