Package com.inductiveautomation.ignition.common.tags.config

Enum TagExecutionMode

  • All Implemented Interfaces:
    Localized, java.io.Serializable, java.lang.Comparable<TagExecutionMode>
    public enum TagExecutionMode
extends java.lang.Enum<TagExecutionMode>
implements Localized
    Settings to determine how a tag is executed by an execution manager.
    Since:
    8.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EventDriven
      Indicates that an execution will only occur if some external event occurs
      FixedRate
      Execution will occur at a fixed rate determined by the user
      TagGroupRate
      Execution will occur at the rate specified in the tag's TagGroup

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString​(java.util.Locale locale)  
      static TagExecutionMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TagExecutionMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • EventDriven

        public static final TagExecutionMode EventDriven
        Indicates that an execution will only occur if some external event occurs

      • FixedRate

        public static final TagExecutionMode FixedRate
        Execution will occur at a fixed rate determined by the user

      • TagGroupRate

        public static final TagExecutionMode TagGroupRate
        Execution will occur at the rate specified in the tag's TagGroup

    • Method Detail

      • values

        public static TagExecutionMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (TagExecutionMode c : TagExecutionMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static TagExecutionMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • toString

        public java.lang.String toString​(java.util.Locale locale)
        Specified by:
        toString in interface Localized