org.sensingkit.sensingkitlib

Interface SensingKitLibInterface

All Known Implementing Classes:

SensingKitLib

public interface SensingKitLibInterface

Method Summary

Methods

Modifier and Type	Method and Description
void	deregisterSensor(SKSensorType sensorType) Deregisters a sensor from the library.
long	getCurrentTimeMillis() Get the current time in milliseconds (the difference between the current time and midnight, January 1, 1970 UTC).
SKSensorData	getDataFromSensor(SKSensorType sensorType) One Shot Sensing
long	getNanoTime() Get the current time in nanoseconds (the current value of the running Java Virtual Machine's high-resolution time source)
boolean	isSensorRegistered(SKSensorType sensorType) A Boolean value that indicates whether the sensor is registered.
boolean	isSensorSensing(SKSensorType sensorType) A Boolean value that indicates whether the sensor is currently sensing.
void	registerSensor(SKSensorType sensorType) Initializes and registers a sensor into the library with a default sensor configuration.
void	startContinuousSensingWithAllRegisteredSensors() Starts continuous sensing with all registered sensors.
void	startContinuousSensingWithSensor(SKSensorType sensorType) Starts continuous sensing with the specified sensor.
void	stopContinuousSensingWithAllRegisteredSensors() Starts continuous sensing with all registered sensors.
void	stopContinuousSensingWithSensor(SKSensorType sensorType) Stops continuous sensing with the specified sensor.
void	subscribeSensorDataListener(SKSensorType sensorType, SKSensorDataListener dataListener) Subscribes for sensor updates using a specified event listener.
void	unsubscribeAllSensorDataListeners(SKSensorType sensorType) Unsubscribes all event listenerss.
void	unsubscribeSensorDataListener(SKSensorType sensorType, SKSensorDataListener dataListener) Unsubscribes an event listener.

Method Detail

registerSensor

void registerSensor(SKSensorType sensorType)
                    throws SKException

Initializes and registers a sensor into the library with a default sensor configuration.

Parameters:

sensorType - The type of the sensor that will be initialized and registered in the library.

Throws:

SKException

deregisterSensor

void deregisterSensor(SKSensorType sensorType)
                      throws SKException

Deregisters a sensor from the library. Sensor should not be actively sensing when this method is called. All previously subscribed blocks will also be unsubscribed.

Parameters:

sensorType - The type of the sensor that will be deregistered.

Throws:

SKException

isSensorRegistered

boolean isSensorRegistered(SKSensorType sensorType)
                           throws SKException

A Boolean value that indicates whether the sensor is registered.

Parameters:

sensorType - The type of the sensor that will be checked.

Returns:

TRUE if the sensor is registered or FALSE if it is not.

Throws:

SKException

getDataFromSensor

SKSensorData getDataFromSensor(SKSensorType sensorType)
                               throws SKException

One Shot Sensing

Throws:

SKException

subscribeSensorDataListener

void subscribeSensorDataListener(SKSensorType sensorType,
                               SKSensorDataListener dataListener)
                                 throws SKException

Subscribes for sensor updates using a specified event listener.

Parameters:

sensorType - The type of the sensor that the data handler will be subscribed to.

dataListener - An event listener that is invoked with each update to handle new sensor data. The block must conform to the SKSensorDataListener type.

Throws:

SKException

unsubscribeSensorDataListener

void unsubscribeSensorDataListener(SKSensorType sensorType,
                                 SKSensorDataListener dataListener)
                                   throws SKException

Unsubscribes an event listener.

Parameters:

sensorType - The type of the sensor for which the event listener will be unsubscribed.

dataListener - The event listener to be unsubscribed.

Throws:

SKException

unsubscribeAllSensorDataListeners

void unsubscribeAllSensorDataListeners(SKSensorType sensorType)
                                       throws SKException

Unsubscribes all event listenerss.

Parameters:

sensorType - The type of the sensor for which the event listener will be unsubscribed.

Throws:

SKException

startContinuousSensingWithSensor

void startContinuousSensingWithSensor(SKSensorType sensorType)
                                      throws SKException

Starts continuous sensing with the specified sensor.

Parameters:

sensorType - The type of the sensor that will be started.

Throws:

SKException

stopContinuousSensingWithSensor

void stopContinuousSensingWithSensor(SKSensorType sensorType)
                                     throws SKException

Stops continuous sensing with the specified sensor.

Parameters:

sensorType - The type of the sensor that will be stopped.

Throws:

SKException

startContinuousSensingWithAllRegisteredSensors

void startContinuousSensingWithAllRegisteredSensors()
                                                    throws SKException

Starts continuous sensing with all registered sensors.

Throws:

SKException

stopContinuousSensingWithAllRegisteredSensors

void stopContinuousSensingWithAllRegisteredSensors()
                                                   throws SKException

Starts continuous sensing with all registered sensors.

Throws:

SKException

isSensorSensing

boolean isSensorSensing(SKSensorType sensorType)
                        throws SKException

A Boolean value that indicates whether the sensor is currently sensing.

Parameters:

sensorType - The type of the sensor that will be checked.

Returns:

TRUE if the sensor is currently sensing or FALSE if it is not.

Throws:

SKException

getCurrentTimeMillis

long getCurrentTimeMillis()

Get the current time in milliseconds (the difference between the current time and midnight, January 1, 1970 UTC).

Returns:

current time in milliseconds

getNanoTime

long getNanoTime()

Get the current time in nanoseconds (the current value of the running Java Virtual Machine's high-resolution time source)

Returns:

current time in nanoseconds