Package es.situm.sdk.location

Enum Class OutdoorLocationOptions.BuildingDetector

java.lang.Object

java.lang.Enum<OutdoorLocationOptions.BuildingDetector>

es.situm.sdk.location.OutdoorLocationOptions.BuildingDetector

All Implemented Interfaces:

Serializable, Comparable<OutdoorLocationOptions.BuildingDetector>, Constable

Enclosing class:

OutdoorLocationOptions

public static enum OutdoorLocationOptions.BuildingDetector
extends Enum<OutdoorLocationOptions.BuildingDetector>

Allows to configure how Situm SDK will detect the building where the user is (building detector strategy).

If no suitable building is found, Outdoor Positioning will start and the detector will keep running in case the user enters a building. On the contrary, if a suitable building is detected, Indoor Positioning will start in it. If the user goes out of that building, the building detector will deselect it, stop the Indoor Positioning, start Outdoor Positioning and keep looking for a new suitable building.

A thorough description of each detector can be found here.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLE	The user will be geolocated inside the building whose BLE calibration signals match better with those perceived by the user smartphone.
GPS_PROXIMITY	The user will be geolocated in the nearest building (based on the GPS distance) from those within a certain maximum range of 100 meters to the borders of the building canvas (floorplan).
WIFI	The user will be geolocated inside the building whose WiFi calibration signals match better with those perceived by the user smartphone.
WIFI_AND_BLE	The user will be geolocated inside the building whose WiFi and BLE calibration signals match better with those perceived by the user smartphone.

Method Summary

Modifier and Type	Method	Description
boolean	useBle()	Tells us whether BLE scans are used by the building detector.
boolean	useWifi()	Tells us whether WiFi scans are used by the building detector.
static OutdoorLocationOptions.BuildingDetector	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OutdoorLocationOptions.BuildingDetector[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GPS_PROXIMITY

public static final OutdoorLocationOptions.BuildingDetector GPS_PROXIMITY

The user will be geolocated in the nearest building (based on the GPS distance) from those within a certain maximum range of 100 meters to the borders of the building canvas (floorplan).

The detected building will only be deselected if the user goes out of the 100 range.

Requires OutdoorLocationOptions.Builder.enableOutdoorPositions(boolean) to be true. Re-computes the GPS distance from the smartphone to the buildings at a maximum rate that depends on the OutdoorLocationOptions.getComputeInterval() value.

WIFI_AND_BLE

public static final OutdoorLocationOptions.BuildingDetector WIFI_AND_BLE

The user will be geolocated inside the building whose WiFi and BLE calibration signals match better with those perceived by the user smartphone.

This building will only be deselected if the user goes out of the WiFi and BLE range. In other words, she must go out until no WiFI and/or BLE signal from that building is received by the smartphone. After that, the building detection process will re-start.

WIFI

public static final OutdoorLocationOptions.BuildingDetector WIFI

The user will be geolocated inside the building whose WiFi calibration signals match better with those perceived by the user smartphone.

This building will only be deselected if the user goes out of the WiFi and BLE range. In other words, she must go out until no WiFI signal from that building is received by the smartphone. After that, the building detection process will re-start.

BLE

public static final OutdoorLocationOptions.BuildingDetector BLE

The user will be geolocated inside the building whose BLE calibration signals match better with those perceived by the user smartphone.

This building will only be deselected if the user goes out of the WiFi and BLE range. In other words, she must go out until no BLE signal from that building is received by the smartphone. After that, the building detection process will re-start.

Method Details

values

public static OutdoorLocationOptions.BuildingDetector[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OutdoorLocationOptions.BuildingDetector valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

useWifi

public boolean useWifi()

Tells us whether WiFi scans are used by the building detector.

WiFi scans are used by WIFI and WIFI_AND_BLE strategies.

If both useBle() and useWifi() methods return false, GPS_PROXIMITY strategy is being used.

Returns:

Boolean

useBle

public boolean useBle()

Tells us whether BLE scans are used by the building detector.

BLE scans are used by BLE and WIFI_AND_BLE strategies.

If both useBle() and useWifi() methods return false, GPS_PROXIMITY strategy is being used.

Returns:

Boolean