com.indooratlas.android.sdk

Class IALocation

java.lang.Object

com.indooratlas.android.sdk.IALocation

All Implemented Interfaces:

android.os.Parcelable

public class IALocation
extends java.lang.Object
implements android.os.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

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<IALocation>	CREATOR
static java.lang.String	EXTRA_FLOOR_CERTAINTY Key used when storing floor level information under Location.getExtras().
static java.lang.String	EXTRA_FLOOR_LEVEL Key used when storing floor level information under Location.getExtras().
static java.lang.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(android.os.Parcel in) Do not use this constructor directly.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(java.lang.Object o)
static IALocation	from(IARegion region) Convenience method to construct IALocation object based on given IARegion.
static IALocation	from(android.content.Intent intent) Extracts an IALocation from the extras of an Intent or null if not present.
static IALocation	from(android.location.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 the floor plan information associated with this location as an IARegion.
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()
android.location.Location	toLocation() Returns a platform location representing the same coordinate location as this instance.
java.lang.String	toString()
void	writeToParcel(android.os.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 java.lang.String EXTRA_REGION

Key used when storing region information under Location.getExtras().

See Also:

toLocation(), Constant Field Values

EXTRA_FLOOR_LEVEL

public static final java.lang.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 java.lang.String EXTRA_FLOOR_CERTAINTY

Key used when storing floor level information under Location.getExtras().

See Also:

toLocation(), Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<IALocation> CREATOR

Constructor Detail

IALocation

protected IALocation(android.os.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(android.location.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)

from

public static IALocation from(android.content.Intent intent)

Extracts an IALocation from the extras of an Intent or null if not present. Use this utility method for received Intents after requesting location updates with IALocationManager.requestLocationUpdates(IALocationRequest, PendingIntent). The location is stored in the extra Bundle a byte array with the IALocationManager.EXTRA_LOCATION key.

Parameters:

intent - Intent to extract the IALocation from. Can be null.

Returns:

an IALocation or null

toLocation

public android.location.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. Matches the floor level of the IAFloorPlan that this location is on. The floor levels of the IAFloorPlans are defined in the mapping phase. Returns floor level or 0 if no floor plan information is available at this location.

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 the floor plan information associated with this location as an IARegion.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable