Package org.osgi.service.dal.functions
Interface BooleanSensor
-
- All Superinterfaces:
Function
public interface BooleanSensor extends Function
BooleanSensor
function 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.LIGHT
Types.GAS
Types.SMOKE
Types.DOOR
Types.WINDOW
Types.POWER
Types.RAIN
Types.CONTACT
Types.FIRE
Types.OCCUPANCY
Types.WATER
Types.MOTION
- other type defined in
Types
- custom - vendor specific type
- See Also:
BooleanData
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BooleanData
getData()
Returns theBooleanSensor
current 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 theBooleanSensor
current state. It's a getter method forPROPERTY_DATA
property.- Returns:
- The
BooleanSensor
current state. - Throws:
java.lang.IllegalStateException
- If this function service object has already been unregistered.DeviceException
- If an operation error is available.- See Also:
BooleanData
-
-