Package com.inductiveautomation.perspective.common.config.binding

Class PollingConfig

  • public class PollingConfig
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      boolean enabled  
      java.lang.String expression  

    • Constructor Summary

      Constructors 
      Constructor Description
      PollingConfig​(boolean enabled, java.lang.String expression)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static PollingConfig fromJson​(com.inductiveautomation.ignition.common.gson.JsonObject jsonObject)
      Parses a json object expected to have "enabled" and "rate" in it.
      java.lang.String getRateExpression()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • enabled

        public final boolean enabled

      • expression

        public final java.lang.String expression

    • Constructor Detail

      • PollingConfig

        public PollingConfig​(boolean enabled,
                     java.lang.String expression)

    • Method Detail

      • fromJson

        public static PollingConfig fromJson​(@Nullable
                                     com.inductiveautomation.ignition.common.gson.JsonObject jsonObject)
                              throws ConfigurationException
        Parses a json object expected to have "enabled" and "rate" in it. If the jsonobject is null, a polling config of enabled=false, rate="30" will be used as a default.
        Throws:
        ConfigurationException

      • getRateExpression

        @Nullable
public java.lang.String getRateExpression()
        Returns:
        The polling rate expression, or null if polling is disabled