com.dff.cordova.plugin.location.classes

Class DistanceCalculator

java.lang.Object

com.dff.cordova.plugin.location.classes.DistanceCalculator

public class DistanceCalculator
extends java.lang.Object

Class calculate distance appropriate to two location: a start and an end locations.

Since:

12.12.2016

Constructor Summary

Constructors

Constructor and Description
DistanceCalculator() Default constructor: properties are initialized with null or respectively 0.

Method Summary

Modifier and Type	Method and Description
float	getAchievedDistance(android.location.Location newLocation)
float	getDistance()
android.location.Location	getEndLocation()
android.location.Location	getStartLocation()
void	init(android.location.Location firstLocation) First initialize of the object.
void	reset() Reset the properties with null or respectively 0.
void	restore(android.content.Context context, int type) Try to restore the distance property from the shared preference if are available
java.lang.String	toString() String representation for the distance calculator
void	update(android.location.Location newLocation) Update the properties on receiving a new location

Methods inherited from class java.lang.Object

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

Constructor Detail

DistanceCalculator

public DistanceCalculator()

Default constructor: properties are initialized with null or respectively 0.

Method Detail

getStartLocation

public android.location.Location getStartLocation()

getEndLocation

public android.location.Location getEndLocation()

getDistance

public float getDistance()

init

public void init(android.location.Location firstLocation)

First initialize of the object. In this case the start location is equal the end location.

Parameters:

firstLocation - - The first received location

update

public void update(android.location.Location newLocation)

Update the properties on receiving a new location

Parameters:

newLocation - - The new location received

getAchievedDistance

public float getAchievedDistance(android.location.Location newLocation)

reset

public void reset()

Reset the properties with null or respectively 0.

restore

public void restore(android.content.Context context,
                    int type)

Try to restore the distance property from the shared preference if are available

Parameters:

context - - The context of the application

type - - The type of the request: 0 for fetching the total distance - 1 for the custom one.

toString

public java.lang.String toString()

String representation for the distance calculator

Overrides:

toString in class java.lang.Object

Returns:

- The Representation