PlaceLikelihood

public abstract class PlaceLikelihood extends Object
implements Parcelable

A Place and the relative likelihood of the place being the best match within the list of returned places for a single request.

Constant Summary

double LIKELIHOOD_MAX_VALUE The highest likelihood possible, i.e the user is most likely to be here.
double LIKELIHOOD_MIN_VALUE The lowest likelihood possible, i.e the user is least likely to be here.

Inherited Constant Summary

Public Constructor Summary

Public Method Summary

abstract double
getLikelihood()
Returns a value indicating the degree of confidence that the device is at the corresponding Place from LIKELIHOOD_MIN_VALUE to LIKELIHOOD_MAX_VALUE (inclusive).
abstract Place
getPlace()
Returns the Place associated with this PlaceLikelihood.
static PlaceLikelihood
newInstance(Place place, double likelihood)
Creates a PlaceLikelihood.

Inherited Method Summary

Constants

public static final double LIKELIHOOD_MAX_VALUE

The highest likelihood possible, i.e the user is most likely to be here. See getLikelihood() for more information.

Constant Value: 1.0

public static final double LIKELIHOOD_MIN_VALUE

The lowest likelihood possible, i.e the user is least likely to be here. See getLikelihood() for more information.

Constant Value: 0.0

Public Constructors

public PlaceLikelihood ()

Public Methods

public abstract double getLikelihood ()

Returns a value indicating the degree of confidence that the device is at the corresponding Place from LIKELIHOOD_MIN_VALUE to LIKELIHOOD_MAX_VALUE (inclusive).

public abstract Place getPlace ()

Returns the Place associated with this PlaceLikelihood.

public static PlaceLikelihood newInstance (Place place, double likelihood)

Creates a PlaceLikelihood.

Parameters
place
likelihood
Throws
IllegalArgumentException If likelihood is out of range: LIKELIHOOD_MIN_VALUE <= likelihood <= LIKELIHOOD_MAX_VALUE.