Class SampleQuality

java.lang.Object
com.inductiveautomation.historian.gateway.api.query.util.SampleQuality

public final class SampleQuality extends Object
How every aggregated route reads a stored sample's quality: its level, with a held value counted as Bad; whether a quality filter admits it at that level; and whether it is noise, a sample with no value that the filter admits, which the read ignores as if it had never been stored.
  • Field Details

    • HELD

      public static final List<QualityCode> HELD
      The codes stored for a value held after a lost connection or a placeholder, in the order the engines render them; stored without info bits, so their user codes match exactly.
  • Method Details

    • aggregatedLevel

      public static QualityCode.Level aggregatedLevel(@Nullable QualityCode quality)
      A sample's level: Bad for a HELD code, else its own; Good for one with no quality.
    • admits

      public static boolean admits(QualityLevelFilter levels, @Nullable QualityCode quality)
      Whether levels admit a sample of quality by its aggregatedLevel(QualityCode).
    • isNoise

      public static boolean isNoise(@Nullable Object value, @Nullable QualityCode quality, QualityLevelFilter admitted)
      Whether every aggregated read ignores a stored sample, as if it had never been stored: it has no value (none, or a NaN or infinite reading) and admitted admits its level. A refused sample with no value still marks its time.
    • boundLevels

      public static QualityLevelFilter boundLevels(QualityLevelFilter admitted)
      The levels a bound that competes with a window's values, or stands at its end, may come from: Good, Uncertain and every level admitted admits.