org.osgi.service.dal.functions

Interface MultiLevelSensor

All Superinterfaces:

Function

public interface MultiLevelSensor
extends Function

MultiLevelSensor function provides multi-level sensor monitoring. It reports its state when an important event is available. The eventable state is accessible with getData() getter. There are no operations.

The sensor type can be:

• Types.LIGHT
• Types.TEMPERATURE
• Types.FLOW
• Types.PRESSURE
• Types.HUMIDITY
• Types.GAS
• Types.SMOKE
• Types.DOOR
• Types.WINDOW
• Types.LIQUID
• Types.POWER
• Types.NOISINESS
• Types.RAIN
• other type defined in Types
• custom - vendor specific type

See Also:

LevelData

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_DATA Specifies the state property name.

Fields inherited from interface org.osgi.service.dal.Function

SERVICE_DESCRIPTION, SERVICE_DEVICE_UID, SERVICE_OPERATION_NAMES, SERVICE_PROPERTY_NAMES, SERVICE_REFERENCE_UIDS, SERVICE_TYPE, SERVICE_UID, SERVICE_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
LevelData	getData() Returns the MultiLevelSensor current state.

Methods inherited from interface org.osgi.service.dal.Function

getOperationMetadata, getPropertyMetadata, getServiceProperty, getServicePropertyKeys

Field Detail

PROPERTY_DATA

static final String PROPERTY_DATA

Specifies the state property name. The eventable property can be read with getData() getter.

See Also:

LevelData, Constant Field Values

Method Detail

getData

LevelData getData()
                  throws DeviceException

Returns the MultiLevelSensor current state. It's a getter method for PROPERTY_DATA property.

Returns:

The MultiLevelSensor current state.

Throws:

IllegalStateException - If this function service object has already been unregistered.

DeviceException - If an operation error is available.

See Also:

LevelData