org.sensingkit.sensingkitlib

Class SensingKitLib

java.lang.Object

org.sensingkit.sensingkitlib.SensingKitLib

All Implemented Interfaces:

SensingKitLibInterface

public class SensingKitLib
extends java.lang.Object
implements 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)
static SensingKitLibInterface	getSensingKitLib(Context context)
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.

Methods inherited from class java.lang.Object

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

Method Detail

getSensingKitLib

public static SensingKitLibInterface getSensingKitLib(Context context)
                                               throws SKException

Throws:

SKException

registerSensor

public void registerSensor(SKSensorType sensorType)
                    throws SKException

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

Specified by:

registerSensor in interface SensingKitLibInterface

Parameters:

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

Throws:

SKException

deregisterSensor

public 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.

Specified by:

deregisterSensor in interface SensingKitLibInterface

Parameters:

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

Throws:

SKException

isSensorRegistered

public boolean isSensorRegistered(SKSensorType sensorType)
                           throws SKException

A Boolean value that indicates whether the sensor is registered.

Specified by:

isSensorRegistered in interface SensingKitLibInterface

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

public SKSensorData getDataFromSensor(SKSensorType sensorType)
                               throws SKException

Description copied from interface: SensingKitLibInterface

One Shot Sensing

Specified by:

getDataFromSensor in interface SensingKitLibInterface

Throws:

SKException

subscribeSensorDataListener

public void subscribeSensorDataListener(SKSensorType sensorType,
                               SKSensorDataListener dataListener)
                                 throws SKException

Subscribes for sensor updates using a specified event listener.

Specified by:

subscribeSensorDataListener in interface SensingKitLibInterface

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

public void unsubscribeSensorDataListener(SKSensorType sensorType,
                                 SKSensorDataListener dataListener)
                                   throws SKException

Unsubscribes an event listener.

Specified by:

unsubscribeSensorDataListener in interface SensingKitLibInterface

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

public void unsubscribeAllSensorDataListeners(SKSensorType sensorType)
                                       throws SKException

Unsubscribes all event listenerss.

Specified by:

unsubscribeAllSensorDataListeners in interface SensingKitLibInterface

Parameters:

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

Throws:

SKException

startContinuousSensingWithSensor

public void startContinuousSensingWithSensor(SKSensorType sensorType)
                                      throws SKException

Starts continuous sensing with the specified sensor.

Specified by:

startContinuousSensingWithSensor in interface SensingKitLibInterface

Parameters:

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

Throws:

SKException

stopContinuousSensingWithSensor

public void stopContinuousSensingWithSensor(SKSensorType sensorType)
                                     throws SKException

Stops continuous sensing with the specified sensor.

Specified by:

stopContinuousSensingWithSensor in interface SensingKitLibInterface

Parameters:

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

Throws:

SKException

startContinuousSensingWithAllRegisteredSensors

public void startContinuousSensingWithAllRegisteredSensors()
                                                    throws SKException

Starts continuous sensing with all registered sensors.

Specified by:

startContinuousSensingWithAllRegisteredSensors in interface SensingKitLibInterface

Throws:

SKException

stopContinuousSensingWithAllRegisteredSensors

public void stopContinuousSensingWithAllRegisteredSensors()
                                                   throws SKException

Starts continuous sensing with all registered sensors.

Specified by:

stopContinuousSensingWithAllRegisteredSensors in interface SensingKitLibInterface

Throws:

SKException

isSensorSensing

public boolean isSensorSensing(SKSensorType sensorType)
                        throws SKException

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

Specified by:

isSensorSensing in interface SensingKitLibInterface

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

public long getCurrentTimeMillis()

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

Specified by:

getCurrentTimeMillis in interface SensingKitLibInterface

Returns:

current time in milliseconds

getNanoTime

public long getNanoTime()

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

Specified by:

getNanoTime in interface SensingKitLibInterface

Returns:

current time in nanoseconds