OSGi 8.1.0 · org.osgi.service.dal.functions.Meter · APIdia, the JavaDoc alternative

Meter function can measure metering information. The function provides these properties:

PROPERTY_CURRENT - eventable property accessible with getCurrent() getter;
PROPERTY_TOTAL - eventable property accessible with getTotal() getter.

The sensor type can be:

Types#PRESSURE
Types#GAS
Types#POWER
Types#WATER
Types#HEAT
Types#COLD
other type defined in Types
custom - vendor specific type

Field Summary

Modifier and Type	Field and Description
public static final String	FLOW_IN Represents the metering consumption flow.
public static final String	FLOW_OUT Represents the metering production flow.
public static final String	PROPERTY_CURRENT Specifies the current consumption or production property name.
public static final String	PROPERTY_TOTAL Specifies the total consumption or production property name.
public static final String	SERVICE_FLOW The service property value contains the metering flow.

Inherited from 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

Modifier and Type	Method and Description
public LevelData	Returns: The current metering info. getCurrent() Returns the current metering info.
public LevelData	Returns: The total metering info. getTotal() Returns the total metering info.

Inherited from org.osgi.service.dal.Function:: getOperationMetadata getPropertyMetadata getServiceProperty getServicePropertyKeys

Field Detail

FLOW_IN	back to summary
public static final String FLOW_IN Represents the metering consumption flow. It can be used as `SERVICE_FLOW` property value.

FLOW_OUT	back to summary
public static final String FLOW_OUT Represents the metering production flow. It can be used as `SERVICE_FLOW` property value.

PROPERTY_CURRENT	back to summary
public static final String PROPERTY_CURRENT Specifies the current consumption or production property name. The eventable property can be read with `getCurrent()` getter.

PROPERTY_TOTAL	back to summary
public static final String PROPERTY_TOTAL Specifies the total consumption or production property name. The eventable property can be read with `getTotal()` getter.

SERVICE_FLOW back to summary

SERVICE_FLOW	back to summary
public static final String SERVICE_FLOW The service property value contains the metering flow. It's an optional property and available only if it's supported by the meter. The value type is `java.lang.String`. Possible property values: `FLOW_IN` `FLOW_OUT`

public static final String SERVICE_FLOW

The service property value contains the metering flow. It's an optional property and available only if it's supported by the meter. The value type is java.lang.String. Possible property values:

Method Detail

getCurrent back to summary

getCurrent	back to summary
public LevelData getCurrent() throws DeviceException Returns the current metering info. It's a getter method for `PROPERTY_CURRENT` property. Returns:LevelData The current metering info. Exceptions DeviceException: If an operation error is available. IllegalStateException: If this function service object has already been unregistered. See Also `LevelData`

public LevelData getCurrent() throws DeviceException

Returns the current metering info. It's a getter method for PROPERTY_CURRENT property.

Returns:LevelData

The current metering info.

Exceptions

DeviceException:: If an operation error is available.
IllegalStateException:: If this function service object has already been unregistered.

See Also

LevelData

getTotal back to summary

getTotal	back to summary
public LevelData getTotal() throws DeviceException Returns the total metering info. It's a getter method for `PROPERTY_TOTAL` property. Returns:LevelData The total metering info. Exceptions DeviceException: If an operation error is available. IllegalStateException: If this function service object has already been unregistered. See Also `LevelData`

public LevelData getTotal() throws DeviceException

Returns the total metering info. It's a getter method for PROPERTY_TOTAL property.