Package com.inductiveautomation.ignition.gateway.clientcomm

Enum MutabilityMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<MutabilityMode>
    public enum MutabilityMode
extends java.lang.Enum<MutabilityMode>
    Mutability mode represents how a session should interact with external sources of data, such as tags or databases.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      OFF
      Don't communicate with sources at all
      READ_ONLY
      Only read values, don't alter them
      READ_WRITE
      Full read and write access enabled.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canRead()  
      boolean canWrite()  
      static MutabilityMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MutabilityMode[] 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

      • OFF

        public static final MutabilityMode OFF
        Don't communicate with sources at all

      • READ_ONLY

        public static final MutabilityMode READ_ONLY
        Only read values, don't alter them

      • READ_WRITE

        public static final MutabilityMode READ_WRITE
        Full read and write access enabled.

    • Method Detail

      • values

        public static MutabilityMode[] 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 (MutabilityMode c : MutabilityMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static MutabilityMode 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

      • canRead

        public boolean canRead()
        Returns:
        false if the designer session has its gateway comm mode set to "off". Avoid reading from data sources.

      • canWrite

        public boolean canWrite()
        Returns:
        false if the designer session has its gateway comm mode set to "off" or "read-only". Avoid writing back to data sources.