Class OutdoorLocationOptions
- All Implemented Interfaces:
android.os.Parcelable
LocationRequest, this data object configures the Global Mode (see LocationRequest for details) options: Outdoor positioning and Building Detector parameters.
Outdoor Positioning in Situm SDK is mainly provided using the GPS signals (and other location providers made available by Android). Configuring the Outdoor Positioning options lets you, in many ways, configure
how Situm SDK reads and accesses to GPS signals. Relevant builder methods are: enableOutdoorPositions,
computeInterval, updateInterval,
minimumOutdoorLocationAccuracy.
Building Detector is a module that allows to configure how Situm SDK will detect the building where the user is (building detector strategy). Building detectors can set up by passing the
OutdoorLocationOptions.BuildingDetector data object to the Builder.buildingDetector method. Other relevant builder methods are
centerPositionInBuildingDuringTransition,
scansBasedDetectorAlwaysOn and
useGeofencesInBuildingSelector.
This object will be passed to the LocationRequest.Builder.outdoorLocationOptions method when building the LocationRequest. After that, you may start
positioning as always by calling the LocationManager.requestLocationUpdates.
Requirements. ACCESS_FINE_LOCATION permission is required when using Situm SDK in Global Mode. See LocationManager for details.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classBuilder for theOutdoorLocationOptionsclass.static enumAllows to configure how Situm SDK will detect the building where the user is (building detector strategy). -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final android.os.Parcelable.Creator<OutdoorLocationOptions>Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE -
Method Summary
Modifier and TypeMethodDescriptionGets whetherOutdoorLocationOptions.Builder.centerPositionInBuildingDuringTransition(boolean)has been set to true.intbooleanGets the interval (in milliseconds) set inOutdoorLocationOptions.Builder.computeInterval(int).Gets the minimum accuracy value set inOutdoorLocationOptions.Builder.minimumOutdoorLocationAccuracy(int).Gets the interval (in milliseconds) set inOutdoorLocationOptions.Builder.updateInterval(int).inthashCode()Gets whetherOutdoorLocationOptions.Builder.enableOutdoorPositions(boolean)has been set to true.Gets whetherOutdoorLocationOptions.Builder.scansBasedDetectorAlwaysOn(boolean)has been set to true.toString()Gets whetherOutdoorLocationOptions.Builder.useGeofencesInBuildingSelector(boolean)has been set to true.voidwriteToParcel(android.os.Parcel dest, int flags)
-
Field Details
-
CREATOR
-
-
Method Details
-
isScansBasedDetectorAlwaysOn
Gets whetherOutdoorLocationOptions.Builder.scansBasedDetectorAlwaysOn(boolean)has been set to true.- Returns:
- true if
OutdoorLocationOptions.Builder.scansBasedDetectorAlwaysOn(boolean)has been set to true.
-
centerPositionInBuildingDuringTransition
Gets whetherOutdoorLocationOptions.Builder.centerPositionInBuildingDuringTransition(boolean)has been set to true.- Returns:
- true if
OutdoorLocationOptions.Builder.centerPositionInBuildingDuringTransition(boolean)has been set to true.
-
getMinimumOutdoorLocationAccuracy
Gets the minimum accuracy value set inOutdoorLocationOptions.Builder.minimumOutdoorLocationAccuracy(int).- Returns:
- the minimum accuracy value set in
OutdoorLocationOptions.Builder.minimumOutdoorLocationAccuracy(int).
-
isOutdoorPositionsEnabled
Gets whetherOutdoorLocationOptions.Builder.enableOutdoorPositions(boolean)has been set to true.- Returns:
- true if
OutdoorLocationOptions.Builder.enableOutdoorPositions(boolean)has been set to true.
-
useGeofencesInBuildingSelector
Gets whetherOutdoorLocationOptions.Builder.useGeofencesInBuildingSelector(boolean)has been set to true.- Returns:
- true if
OutdoorLocationOptions.Builder.useGeofencesInBuildingSelector(boolean)has been set to true.
-
getBuildingDetector
Gets theOutdoorLocationOptions.BuildingDetectorset byOutdoorLocationOptions.Builder.buildingDetector(OutdoorLocationOptions.BuildingDetector).- Returns:
- the
OutdoorLocationOptions.BuildingDetectorinstance.
-
getUpdateInterval
Gets the interval (in milliseconds) set inOutdoorLocationOptions.Builder.updateInterval(int).- Returns:
- the interval (in milliseconds) set in
OutdoorLocationOptions.Builder.updateInterval(int).
-
getComputeInterval
Gets the interval (in milliseconds) set inOutdoorLocationOptions.Builder.computeInterval(int).- Returns:
- the interval (in milliseconds) set in
OutdoorLocationOptions.Builder.computeInterval(int).
-
equals
-
hashCode
public int hashCode() -
toString
-
describeContents
public int describeContents()- Specified by:
describeContentsin interfaceandroid.os.Parcelable
-
writeToParcel
public void writeToParcel(android.os.Parcel dest, int flags) - Specified by:
writeToParcelin interfaceandroid.os.Parcelable
-