Class LocationSettings

Package world.mappable.mapkit.location

java.lang.Object
↳ world.mappable.mapkit.location.LocationSettings

final class LocationSettings implements Serializable

Summary

Constructors

Signature and Description

LocationSettings(boolean provideAccuracy, @Nullable Range accuracy, @Nullable TimeInterval locationTimeInterval, boolean provideSpeed, double speed, boolean provideHeading, @Nullable Range headingError, @Nullable LocationError locationError, boolean provideWheelSpeed, @Nullable TimeInterval wheelSpeedTimeInterval)

LocationSettings()
Use constructor with parameters in your code.

Methods

Type and modifiers	Method and Description
`boolean`	`getProvideAccuracy()` Flag whether to provide accuracy value.
`LocationSettings`	`setProvideAccuracy(boolean provideAccuracy)` See #getProvideAccuracy().
`Range`	`getAccuracy()` Location accuracy range in meters.
`LocationSettings`	`setAccuracy(@Nullable Range accuracy)` See #getAccuracy().
`TimeInterval`	`getLocationTimeInterval()` Location time interval in milliseconds.
`LocationSettings`	`setLocationTimeInterval(@Nullable TimeInterval locationTimeInterval)` See #getLocationTimeInterval().
`boolean`	`getProvideSpeed()` Flag whether to provide speed value.
`LocationSettings`	`setProvideSpeed(boolean provideSpeed)` See #getProvideSpeed().
`double`	`getSpeed()` The speed in meters per second.
`LocationSettings`	`setSpeed(double speed)` See #getSpeed().
`boolean`	`getProvideHeading()` Flag whether to provide error of heading.
`LocationSettings`	`setProvideHeading(boolean provideHeading)` See #getProvideHeading().
`Range`	`getHeadingError()` The current heading error range in degrees relative to true heading, clockwise.
`LocationSettings`	`setHeadingError(@Nullable Range headingError)` See #getHeadingError().
`LocationError`	`getLocationError()` Optional field, can be null.
`LocationSettings`	`setLocationError(@Nullable LocationError locationError)` See #getLocationError().
`boolean`	`getProvideWheelSpeed()` Flag whether to provide wheel speed value.
`LocationSettings`	`setProvideWheelSpeed(boolean provideWheelSpeed)` See #getProvideWheelSpeed().
`TimeInterval`	`getWheelSpeedTimeInterval()` Time interval of getting the wheel speed in milliseconds.
`LocationSettings`	`setWheelSpeedTimeInterval(@Nullable TimeInterval wheelSpeedTimeInterval)` See #getWheelSpeedTimeInterval().
`void`	`serialize(world.mappable.runtime.bindings.Archive archive)`

Constuctors

LocationSettings

LocationSettings(boolean provideAccuracy, @Nullable Range accuracy, @Nullable TimeInterval locationTimeInterval, boolean provideSpeed, double speed, boolean provideHeading, @Nullable Range headingError, @Nullable LocationError locationError, boolean provideWheelSpeed, @Nullable TimeInterval wheelSpeedTimeInterval)

LocationSettings

LocationSettings()

Use constructor with parameters in your code.

This one is for bindings only!

Methods

getProvideAccuracy

boolean getProvideAccuracy()

Flag whether to provide accuracy value.

setProvideAccuracy

LocationSettings setProvideAccuracy(boolean provideAccuracy)

See #getProvideAccuracy().

getAccuracy

@Nullable Range getAccuracy()

Location accuracy range in meters.

Optional field, can be null.

setAccuracy

LocationSettings setAccuracy(@Nullable Range accuracy)

See #getAccuracy().

getLocationTimeInterval

@Nullable TimeInterval getLocationTimeInterval()

Location time interval in milliseconds.

Optional field, can be null.

setLocationTimeInterval

LocationSettings setLocationTimeInterval(@Nullable TimeInterval locationTimeInterval)

See #getLocationTimeInterval().

getProvideSpeed

boolean getProvideSpeed()

Flag whether to provide speed value.

setProvideSpeed

LocationSettings setProvideSpeed(boolean provideSpeed)

See #getProvideSpeed().

getSpeed

double getSpeed()

The speed in meters per second.

setSpeed

LocationSettings setSpeed(double speed)

See #getSpeed().

getProvideHeading

boolean getProvideHeading()

Flag whether to provide error of heading.

setProvideHeading

LocationSettings setProvideHeading(boolean provideHeading)

See #getProvideHeading().

getHeadingError

@Nullable Range getHeadingError()

The current heading error range in degrees relative to true heading, clockwise.

Optional field, can be null.

setHeadingError

LocationSettings setHeadingError(@Nullable Range headingError)

See #getHeadingError().

getLocationError

@Nullable LocationError getLocationError()

Optional field, can be null.

setLocationError

LocationSettings setLocationError(@Nullable LocationError locationError)

See #getLocationError().

getProvideWheelSpeed

boolean getProvideWheelSpeed()

Flag whether to provide wheel speed value.

setProvideWheelSpeed

LocationSettings setProvideWheelSpeed(boolean provideWheelSpeed)

See #getProvideWheelSpeed().

getWheelSpeedTimeInterval

@Nullable TimeInterval getWheelSpeedTimeInterval()

Time interval of getting the wheel speed in milliseconds.

After publication the wheel speed corresponds to the speed value.

Optional field, can be null.

setWheelSpeedTimeInterval

LocationSettings setWheelSpeedTimeInterval(@Nullable TimeInterval wheelSpeedTimeInterval)

See #getWheelSpeedTimeInterval().

serialize

@Override void serialize(world.mappable.runtime.bindings.Archive archive)

Previous

LocationManagerUtils

Next

LocationSettingsFactory