Enum Class StandardAggregates

java.lang.Object
java.lang.Enum<StandardAggregates>
com.inductiveautomation.historian.common.model.StandardAggregates
All Implemented Interfaces:
AggregationType, Serializable, Comparable<StandardAggregates>, Constable

public enum StandardAggregates extends Enum<StandardAggregates> implements AggregationType
The platform's aggregates: the only list the platform owns. Every entry has a gateway fold, so it exists on every provider; an engine that declares an entry by reference computes it under these semantics. Any other id an engine declares is the engine's own.
  • Enum Constant Details

  • Method Details

    • values

      public static StandardAggregates[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static StandardAggregates valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • id

      public AggregateId id()
      Description copied from interface: AggregationType
      Returns this aggregate's identity. A protocol bridge that needs a numeric id keeps it on its own type (see LegacyAggregateAdapter).
      Specified by:
      id in interface AggregationType
      Returns:
      the id.
    • description

      public LocalizedString description()
      Description copied from interface: AggregationType
      Returns the aggregate's description.
      Specified by:
      description in interface AggregationType
      Returns:
      the description.
    • dataType

      public Optional<DataType> dataType()
      The output type; empty where the answer keeps the tag's own type.
      Specified by:
      dataType in interface AggregationType
      Returns:
      the type, or empty when the result takes the type of the tag it was computed over.
    • acceptedInputTypes

      public Set<DataType> acceptedInputTypes()
      Description copied from interface: AggregationType
      Returns the input types this aggregate accepts. The default is the numeric types plus DataType.Boolean, which is stored as an integer and reads back as 0/1, so a time-weighted average of a boolean is its duty cycle. An aggregate that accepts DataType.String declares it here. An engine answers an input type outside this set with the node's own last value.
      Specified by:
      acceptedInputTypes in interface AggregationType
      Returns:
      the accepted input types.
    • interpolations

      public List<Interpolation> interpolations()
      The interpolations this aggregate offers, its default first. Minimum, maximum, range, min_max and last_value offer the edge forms and None; average the edge forms only. The sample statistics read no edges, so they are None only; durations, quality shares and transition counts read the value carried in, so they are Auto only.
      Specified by:
      interpolations in interface AggregationType
    • counter

      public boolean counter()
      Description copied from interface: AggregationType
      Returns whether the aggregate counts samples or transitions, so a window with none counts zero.
      Specified by:
      counter in interface AggregationType
    • usesBounds

      public boolean usesBounds()
      Whether the aggregate reads the signal's values at its window edges.
      Specified by:
      usesBounds in interface AggregationType
    • oneSampleIsSample

      public boolean oneSampleIsSample()
      Whether a window holding one sample has that sample's value.
      Specified by:
      oneSampleIsSample in interface AggregationType
    • takesWindowFill

      public boolean takesWindowFill()
      Whether a window without samples may be filled from the neighbouring windows' results.
      Specified by:
      takesWindowFill in interface AggregationType
    • legacyFills

      public Set<FillMode> legacyFills()
      The classic tag history calculation's fills: Auto and Omit, plus Linear and Previous where it reads them as the interpolation (the value aggregates and simple_average). Never a constant.
      Specified by:
      legacyFills in interface AggregationType
    • takesConstant

      public boolean takesConstant()
      Whether an empty window may take a constant: the value aggregates and sum, not a spread, a count, a duration or a quality share.
      Specified by:
      takesConstant in interface AggregationType
    • isCounter

      public static boolean isCounter(AggregateId id)
      Whether id counts samples or transitions, so a window with none counts zero.
    • foldsOnPlatform

      public static boolean foldsOnPlatform(AggregationType form, DataType inputType)
      Whether the platform folds an engine's form on an inputType key. The min/max envelopes, the Power Chart's default pen, never take an engine's substitute for a type the form does not reduce; every other form the engine lists is the engine's to answer.
    • fromId

      public static Optional<StandardAggregates> fromId(AggregateId id)