Class ArithmeticGroupFunction.Avg

java.lang.Object
org.openhab.core.library.types.ArithmeticGroupFunction.Avg
All Implemented Interfaces:
GroupFunction
Enclosing interface:
ArithmeticGroupFunction

public static class ArithmeticGroupFunction.Avg extends Object implements GroupFunction
This calculates the numeric average over all item states of decimal type.
  • Constructor Details

    • Avg

      public Avg()
  • Method Details

    • calculate

      public State calculate(@Nullable Set<Item> items)
      Description copied from interface: GroupFunction
      Determines the current state of a group based on a list of items
      Specified by:
      calculate in interface GroupFunction
      Parameters:
      items - the items to calculate a group state for
      Returns:
      the calculated group state
    • 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