Package org.osgi.service.dal.functions
Interface BooleanSensor
-
- All Superinterfaces:
Function
public interface BooleanSensor extends Function
BooleanSensorfunction provides boolean sensor monitoring. It reports its state when an important event is available. The eventable state is accessible withgetData()getter. There are no operations.The sensor type can be:
Types.LIGHTTypes.GASTypes.SMOKETypes.DOORTypes.WINDOWTypes.POWERTypes.RAINTypes.CONTACTTypes.FIRETypes.OCCUPANCYTypes.WATERTypes.MOTION- other type defined in
Types - custom - vendor specific type
- See Also:
BooleanData
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringPROPERTY_DATASpecifies 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BooleanDatagetData()Returns theBooleanSensorcurrent state.-
Methods inherited from interface org.osgi.service.dal.Function
getOperationMetadata, getPropertyMetadata, getServiceProperty, getServicePropertyKeys
-
-
-
-
Field Detail
-
PROPERTY_DATA
static final java.lang.String PROPERTY_DATA
Specifies the state property name. The eventable property value is accessible withgetData()getter.- See Also:
- Constant Field Values
-
-
Method Detail
-
getData
BooleanData getData() throws DeviceException
Returns theBooleanSensorcurrent state. It's a getter method forPROPERTY_DATAproperty.- Returns:
- The
BooleanSensorcurrent state. - Throws:
java.lang.IllegalStateException- If this function service object has already been unregistered.DeviceException- If an operation error is available.- See Also:
BooleanData
-
-