org.sensingkit.sensingkitlib

Class SKSensorManager

java.lang.Object

org.sensingkit.sensingkitlib.SKSensorManager

public class SKSensorManager
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
protected SKAbstractSensor	createSensor(SKSensorType sensorType)
void	deregisterSensor(SKSensorType sensorType) Deregisters a sensor from the library.
SKSensorData	getDataFromSensor(SKSensorType sensorType) Get data from the sensor
protected SKAbstractSensor	getSensor(SKSensorType sensorType)
static SKSensorManager	getSensorManager(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() Stops 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

getSensorManager

public static SKSensorManager getSensorManager(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.

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.

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.

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

isSensorSensing

public 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

getSensor

protected SKAbstractSensor getSensor(SKSensorType sensorType)
                              throws SKException

Throws:

SKException

createSensor

protected SKAbstractSensor createSensor(SKSensorType sensorType)
                                 throws SKException

Throws:

SKException

getDataFromSensor

public SKSensorData getDataFromSensor(SKSensorType sensorType)
                               throws SKException

Get data from the sensor

Parameters:

sensorType - of type SKSensorType

Returns:

an SKSensorData object

Throws:

SKException

subscribeSensorDataListener

public 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

public 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

public 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

public 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

public 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

public void startContinuousSensingWithAllRegisteredSensors()
                                                    throws SKException

Starts continuous sensing with all registered sensors.

Throws:

SKException

stopContinuousSensingWithAllRegisteredSensors

public void stopContinuousSensingWithAllRegisteredSensors()
                                                   throws SKException

Stops continuous sensing with all registered sensors.

Throws:

SKException