Package org.openhab.core.library.types

Class QuantityTypeArithmeticGroupFunction.DimensionalGroupFunction

java.lang.Object

org.openhab.core.library.types.QuantityTypeArithmeticGroupFunction.DimensionalGroupFunction

All Implemented Interfaces:

GroupFunction

Direct Known Subclasses:

QuantityTypeArithmeticGroupFunction.Avg, QuantityTypeArithmeticGroupFunction.Max, QuantityTypeArithmeticGroupFunction.Min, QuantityTypeArithmeticGroupFunction.Sum

Enclosing interface:

QuantityTypeArithmeticGroupFunction

public abstract static class QuantityTypeArithmeticGroupFunction.DimensionalGroupFunction
extends Object
implements GroupFunction

Nested Class Summary

Nested classes/interfaces inherited from interface org.openhab.core.items.GroupFunction

GroupFunction.Equality

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<? extends javax.measure.Quantity<?>>	dimension

Constructor Summary

Constructors

Constructor	Description
DimensionalGroupFunction(Class<? extends javax.measure.Quantity<?>> dimension)

Method Summary

Modifier and Type	Method	Description
State[]	getParameters()	Returns the parameters of the function as an array.
<T extends State> @Nullable T	getStateAs(@Nullable Set<Item> items, Class<T> stateClass)	Calculates the group state and returns it as a state of the requested type.
protected boolean	isSameDimension(@Nullable Item item)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openhab.core.items.GroupFunction

calculate

Field Details

dimension

protected final Class<? extends javax.measure.Quantity<?>> dimension

Constructor Details

DimensionalGroupFunction

public DimensionalGroupFunction(Class<? extends javax.measure.Quantity<?>> dimension)

Method Details

getStateAs

public <T extends State> @Nullable T getStateAs(@Nullable Set<Item> items,
 Class<T> stateClass)

Description copied from interface: GroupFunction

Calculates the group state and returns it as a state of the requested type.

Specified by:

getStateAs in interface GroupFunction

Parameters:

items - the items to calculate a group state for

stateClass - the type in which the state should be returned

Returns:

the calculated group state of the requested type or null, if type is not supported

getParameters

public State[] getParameters()

Description copied from interface: GroupFunction

Returns the parameters of the function as an array.

Specified by:

getParameters in interface GroupFunction

Returns:

the parameters of this function

isSameDimension

protected boolean isSameDimension(@Nullable Item item)