com.here.android.mpa.common

Class PositioningManager

java.lang.Object

com.here.android.mpa.common.PositioningManager

public final class PositioningManager
extends java.lang.Object

Represents a manager for information received from positioning devices, such as updates to the current position and the average speed.

If the user of the application revokes the ACCESS_FINE_LOCATION permission at runtime while PositioningManager is active, the application will stop receiving location updates and methods of PositioningManager will stop functioning properly until the ACCESS_FINE_LOCATION permission is restored.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PositioningManager.LocationMethod Represents values describing the location method.
static class	PositioningManager.LocationStatus Represents values describing the location status of a particular location method.
static interface	PositioningManager.OnPositionChangedListener Represents an interface for position update listeners.

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.ref.WeakReference<PositioningManager.OnPositionChangedListener> listener) Adds a PositioningManager.OnPositionChangedListener to the PositioningManager.
double	getAverageSpeed() Gets the average speed of travel, in meters per second.
static PositioningManager	getInstance() Get access to the PositioningManager Singleton
GeoPosition	getLastKnownPosition() Returns the last known (cached) position from the best available provider.
PositioningManager.LocationMethod	getLocationMethod() Gets the method type used to determine positioning.
PositioningManager.LocationStatus	getLocationStatus(PositioningManager.LocationMethod method) Gets the status for a specified LocationMethod.
GeoPosition	getPosition() Gets the GeoPosition for the current PositioningManager.LocationMethod if available.
boolean	hasValidPosition() Determines whether the current position for the current active PositioningManager.LocationMethod is valid.
boolean	hasValidPosition(PositioningManager.LocationMethod method) Determines whether the current position for the specified LocationMethod is valid.
boolean	isActive() Determines whether the PositioningManager is active and whether position updates are being received.
void	removeListener(PositioningManager.OnPositionChangedListener listener) Removes a PositioningManager.OnPositionChangedListener from the PositioningManager.
boolean	start(PositioningManager.LocationMethod method) Starts receiving position updates from the positioning device.
void	stop() Stops receiving position updates from the positioning device.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static PositioningManager getInstance()

Get access to the PositioningManager Singleton

Returns:

PositioningManager instance

start

public boolean start(PositioningManager.LocationMethod method)

Starts receiving position updates from the positioning device.

The PositioningManager will not be started if the application does not have the ACCESS_FINE_LOCATION permission at the time of this call.

Parameters:

method - A LocationMethod used to provide position updates

Returns:

true if position updates have started being received from the positioning device, false otherwise.

stop

public void stop()

Stops receiving position updates from the positioning device.

isActive

public boolean isActive()

Determines whether the PositioningManager is active and whether position updates are being received.

Returns:

True if the PositioningManager is actively receiving position updates, false otherwise

hasValidPosition

public boolean hasValidPosition()

Determines whether the current position for the current active PositioningManager.LocationMethod is valid.

Returns:

True if the position is valid, false otherwise

See Also:

hasValidPosition(LocationMethod)

hasValidPosition

public boolean hasValidPosition(PositioningManager.LocationMethod method)

Determines whether the current position for the specified LocationMethod is valid.

Parameters:

method - A LocationMethod to check for a valid position

Returns:

True if the position is valid, false otherwise

See Also:

hasValidPosition()

getAverageSpeed

public double getAverageSpeed()

Gets the average speed of travel, in meters per second.

Returns:

The average speed

getPosition

public GeoPosition getPosition()

Gets the GeoPosition for the current PositioningManager.LocationMethod if available.

Availability of a position can be checked by way of the hasValidPosition() method, if that method returns false, the best available cached position can be obtained using the getLastKnownPosition() API.

The position returned is determined by the following criteria:

Returns:

The current GeoPosition

See Also:

getLastKnownPosition()

getLastKnownPosition

public GeoPosition getLastKnownPosition()

Returns the last known (cached) position from the best available provider. This is useful if there is no valid device position available (i.e. hasValidPosition() returns false). If hasValidPosition() returns true, please use the getPosition() API.

Returns:

Last known position from the best available provider.

See Also:

getPosition()

getLocationMethod

public PositioningManager.LocationMethod getLocationMethod()

Gets the method type used to determine positioning.

Returns:

The LocationMethod

getLocationStatus

public PositioningManager.LocationStatus getLocationStatus(PositioningManager.LocationMethod method)

Gets the status for a specified LocationMethod.

Parameters:

method - A LocationMethod used to determine the location status

Returns:

The status of the specified LocationMethod

addListener

public void addListener(java.lang.ref.WeakReference<PositioningManager.OnPositionChangedListener> listener)

Adds a PositioningManager.OnPositionChangedListener to the PositioningManager.

Parameters:

listener - A OnPositionChangedListener to add

See Also:

removeListener(OnPositionChangedListener)

removeListener

public void removeListener(PositioningManager.OnPositionChangedListener listener)

Removes a PositioningManager.OnPositionChangedListener from the PositioningManager.

Parameters:

listener - A OnPositionChangedListener to remove

See Also:

addListener(WeakReference)