Class LocationSettings

Package world.mappable.mapkit.location

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

class LocationSettings implements Serializable

Summary

Constructors

Signature and Description

LocationSettings()
Use constructor with parameters in your code.

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

Methods

Type and modifiers

Method and Description

synchronized boolean

getProvideAccuracy()
Flag whether to provide accuracy value.

synchronized Range

getAccuracy()
Location accuracy range in meters.

synchronized TimeInterval

getLocationTimeInterval()
Location time interval in milliseconds.

synchronized boolean

getProvideSpeed()
Flag whether to provide speed value.

synchronized double

getSpeed()
The speed in meters per second.

synchronized boolean

getProvideHeading()
Flag whether to provide error of heading.

synchronized Range

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

synchronized LocationError

getLocationError()

synchronized boolean

getProvideWheelSpeed()
Flag whether to provide wheel speed value.

synchronized TimeInterval

getWheelSpeedTimeInterval()
Time interval of getting the wheel speed in milliseconds.

void

serialize(world.mappable.runtime.bindings.Archive archive)

static java.lang.String

getNativeName()

Constuctors

LocationSettings

LocationSettings()

Use constructor with parameters in your code.

This one is for serialization only!


LocationSettings

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


Methods

getProvideAccuracy

boolean getProvideAccuracy()

Flag whether to provide accuracy value.


getAccuracy

@Nullable
Range getAccuracy()

Location accuracy range in meters.

Optional field, can be null.


getLocationTimeInterval

@NonNull
TimeInterval getLocationTimeInterval()

Location time interval in milliseconds.


getProvideSpeed

boolean getProvideSpeed()

Flag whether to provide speed value.


getSpeed

double getSpeed()

The speed in meters per second.


getProvideHeading

boolean getProvideHeading()

Flag whether to provide error of heading.


getHeadingError

@Nullable
Range getHeadingError()

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

Optional field, can be null.


getLocationError

@NonNull
LocationError getLocationError()


getProvideWheelSpeed

boolean getProvideWheelSpeed()

Flag whether to provide wheel speed value.


getWheelSpeedTimeInterval

@NonNull
TimeInterval getWheelSpeedTimeInterval()

Time interval of getting the wheel speed in milliseconds.

After publication the wheel speed corresponds to the speed value.


serialize

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


getNativeName

java.lang.String getNativeName()