com.mapbox.services.android.location

Class MockLocationEngine

java.lang.Object

com.mapbox.services.android.telemetry.location.LocationEngine

com.mapbox.services.android.location.MockLocationEngine

public class MockLocationEngine
extends com.mapbox.services.android.telemetry.location.LocationEngine

Allows for mocking user location along a route. The route comes from the directions API and is instance of DirectionsRoute. Once the route is passed in the mocking is automatically started. It goes step by step within the directions route. This allows for long routing without memory issues. You have the option to either use the default values for delay (1 second), speed (30m/h), and noisyGps (false) or you can pass in your own values when constructing this object.

Since:

2.2.0

Nested Class Summary

Nested classes/interfaces inherited from class com.mapbox.services.android.telemetry.location.LocationEngine

com.mapbox.services.android.telemetry.location.LocationEngine.Type

Field Summary

Fields inherited from class com.mapbox.services.android.telemetry.location.LocationEngine

fastestInterval, interval, locationListeners, priority, smallestDisplacement

Constructor Summary

Constructors

Constructor and Description
MockLocationEngine() Create a MockLocationEngine instance using the default parameters.
MockLocationEngine(int delay, int speed, boolean noisyGps) Create a MockLocationEngine instance with custom parameters.

Method Summary

Modifier and Type	Method and Description
void	activate() Connect all the location listeners.
void	deactivate() Stops mocking the user location along the route.
int	getDelay()
android.location.Location	getLastLocation() If the lastLocation is not null, this method will return the last location as expected.
int	getSpeed()
boolean	isConnected() While the MockLocationEngine is in use, you are always connected to it.
boolean	isNoisyGps()
void	moveToLocation(com.mapbox.services.commons.models.Position position)
com.mapbox.services.android.telemetry.location.LocationEngine.Type	obtainType()
void	removeLocationUpdates() Removes location updates for the LocationListener.
void	requestLocationUpdates() Nothing needs to happen here since we are mocking the user location along a route.
void	setLastLocation(com.mapbox.services.commons.models.Position currentPosition)
void	setRoute(com.mapbox.services.api.directions.v5.models.DirectionsRoute route) Use this method to pass in a route and start the mocking immediately.

Methods inherited from class com.mapbox.services.android.telemetry.location.LocationEngine

addLocationEngineListener, getFastestInterval, getInterval, getPriority, getSmallestDisplacement, isBetterLocation, removeLocationEngineListener, setFastestInterval, setInterval, setPriority, setSmallestDisplacement

Methods inherited from class java.lang.Object

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

Constructor Detail

MockLocationEngine

public MockLocationEngine()

Create a MockLocationEngine instance using the default parameters.

Since:

2.2.0

MockLocationEngine

public MockLocationEngine(int delay,
                          int speed,
                          boolean noisyGps)

Create a MockLocationEngine instance with custom parameters.

Parameters:

delay - the frequency in which the gps position is updated in milliseconds.

speed - the speed the user is traveling in miles per hour.

noisyGps - true if you want the mock positions to become noisy.

Since:

2.2.0

Method Detail

activate

public void activate()

Connect all the location listeners.

Specified by:

activate in class com.mapbox.services.android.telemetry.location.LocationEngine

Since:

2.2.0

deactivate

public void deactivate()

Stops mocking the user location along the route.

Specified by:

deactivate in class com.mapbox.services.android.telemetry.location.LocationEngine

Since:

2.2.0

isConnected

public boolean isConnected()

While the MockLocationEngine is in use, you are always connected to it.

Specified by:

isConnected in class com.mapbox.services.android.telemetry.location.LocationEngine

Returns:

true.

Since:

2.2.0

getLastLocation

@Nullable
public android.location.Location getLastLocation()

If the lastLocation is not null, this method will return the last location as expected. Otherwise, we return the Mapbox DC office location.

Specified by:

getLastLocation in class com.mapbox.services.android.telemetry.location.LocationEngine

Returns:

a Location which represents the last mock location.

Since:

2.2.0

setLastLocation

public void setLastLocation(com.mapbox.services.commons.models.Position currentPosition)

isNoisyGps

public boolean isNoisyGps()

getSpeed

public int getSpeed()

getDelay

public int getDelay()

requestLocationUpdates

public void requestLocationUpdates()

Nothing needs to happen here since we are mocking the user location along a route.

Specified by:

requestLocationUpdates in class com.mapbox.services.android.telemetry.location.LocationEngine

Since:

2.2.0

removeLocationUpdates

public void removeLocationUpdates()

Removes location updates for the LocationListener.

Specified by:

removeLocationUpdates in class com.mapbox.services.android.telemetry.location.LocationEngine

Since:

2.2.0

obtainType

public com.mapbox.services.android.telemetry.location.LocationEngine.Type obtainType()

Specified by:

obtainType in class com.mapbox.services.android.telemetry.location.LocationEngine

moveToLocation

public void moveToLocation(com.mapbox.services.commons.models.Position position)

setRoute

public void setRoute(com.mapbox.services.api.directions.v5.models.DirectionsRoute route)

Use this method to pass in a route and start the mocking immediately.

Parameters:

route - a DirectionsRoute which you'd like to mock the user location on.

Since:

2.2.0