Package com.inductiveautomation.ignition.common.model

Class ApplicationScope

  • public final class ApplicationScope
extends java.lang.Object
    Various parts of the system allow operations to be filtered based on "scope". This class defines various values and masks that can be used as those parameters.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALL  
      static int CLIENT  
      static int DESIGNER  
      static int GATEWAY  
      static int NONE  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static int getGlobalScope()
      Returns the scope of this jvm, wherever it may be.
      static java.lang.String getScopePrefix()
      Returns the current jvm's scope prefix, for use in thread names.
      static void init​(int globalScope)  
      static boolean isClient​(int scope)  
      static boolean isDesigner​(int scope)  
      static boolean isGateway​(int scope)  
      static int parseScope​(java.lang.String s)
      Returns a bitmask representing application scope for strings like:
      static java.lang.String toCode​(int scope)
      Turns a scope int into the various scope codes: "C"= client, "DC"= designer or client, "G"= gateway, "N"=none, "A"=all.
      static java.lang.String toString​(int scope)  
      static java.lang.String toString​(java.lang.Integer scope, java.util.Locale locale)  

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • parseScope

        public static int parseScope​(java.lang.String s)
        Returns a bitmask representing application scope for strings like:

        "C"= client, "DC"= designer or client, "G"= gateway, "N"=none, "A"=all

      • init

        public static void init​(int globalScope)

      • getGlobalScope

        public static int getGlobalScope()
        Returns the scope of this jvm, wherever it may be. Some code (such as code in common) doesn't know where it will end up running, and this is one way to tell where you are.

      • getScopePrefix

        public static java.lang.String getScopePrefix()
        Returns the current jvm's scope prefix, for use in thread names. "gateway", "designer" or "client"

      • isGateway

        public static boolean isGateway​(int scope)

      • isClient

        public static boolean isClient​(int scope)

      • isDesigner

        public static boolean isDesigner​(int scope)

      • toString

        public static java.lang.String toString​(int scope)

      • toString

        public static java.lang.String toString​(java.lang.Integer scope,
                                        java.util.Locale locale)

      • toCode

        public static java.lang.String toCode​(int scope)
        Turns a scope int into the various scope codes: "C"= client, "DC"= designer or client, "G"= gateway, "N"=none, "A"=all. Scope codes can be combined (such as "CD"), but "A" is always returned instead of "CDG"