Module com.gluonhq.attach.magnetometer

Package com.gluonhq.attach.magnetometer.impl

Class MobileMagnetometerService

java.lang.Object

com.gluonhq.attach.magnetometer.impl.MobileMagnetometerService

All Implemented Interfaces:

MagnetometerService

Direct Known Subclasses:

AndroidMagnetometerService, IOSMagnetometerService

public abstract class MobileMagnetometerService
extends Object
implements MagnetometerService

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ReadOnlyObjectProperty<MagnetometerReading>	reading	A frequently-updated reading from the magnetometer.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final javafx.beans.property.ReadOnlyObjectWrapper<MagnetometerReading>	reading

Fields inherited from interface com.gluonhq.attach.magnetometer.MagnetometerService

DEFAULT_PARAMETERS

Constructor Summary

Constructors

Constructor	Description
MobileMagnetometerService()

Method Summary

Modifier and Type	Method	Description
MagnetometerReading	getReading()	Gets the value of the property reading.
javafx.beans.property.ReadOnlyObjectProperty<MagnetometerReading>	readingProperty()	A frequently-updated reading from the magnetometer.
void	start()	Starts the service with MagnetometerService.DEFAULT_PARAMETERS.
void	start(Parameters parameters)	Starts the service with given parameters.
protected abstract void	startMagnetometerImpl(double frequency)
void	stop()	Stops the service.
protected abstract void	stopMagnetometerImpl()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

reading

public javafx.beans.property.ReadOnlyObjectProperty<MagnetometerReading> readingProperty

Specified by:

readingProperty in interface MagnetometerService

See Also:

• getReading()

Field Details

reading

protected static final javafx.beans.property.ReadOnlyObjectWrapper<MagnetometerReading> reading

Constructor Details

MobileMagnetometerService

public MobileMagnetometerService()

Method Details

readingProperty

public javafx.beans.property.ReadOnlyObjectProperty<MagnetometerReading> readingProperty()

Description copied from interface: MagnetometerService

A frequently-updated reading from the magnetometer.

Specified by:

readingProperty in interface MagnetometerService

See Also:

• getReading()

getReading

public MagnetometerReading getReading()

Gets the value of the property reading.

Specified by:

getReading in interface MagnetometerService

Property description:

Returns:

the current magnetometer reading

start

public void start()

Description copied from interface: MagnetometerService

Starts the service with MagnetometerService.DEFAULT_PARAMETERS.

Specified by:

start in interface MagnetometerService

start

public void start(Parameters parameters)

Description copied from interface: MagnetometerService

Starts the service with given parameters.

Specified by:

start in interface MagnetometerService

Parameters:

parameters - Parameters for configuring the service

stop

public void stop()

Description copied from interface: MagnetometerService

Stops the service.

Specified by:

stop in interface MagnetometerService

startMagnetometerImpl

protected abstract void startMagnetometerImpl(double frequency)

stopMagnetometerImpl

protected abstract void stopMagnetometerImpl()