Package com.inductiveautomation.ignition.common

Class WellKnownPathTypes

  • public class WellKnownPathTypes
extends java.lang.Object
    These are path identifiers used by QualifiedPath for the well-known objects in Ignition.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String Alarm  
      static java.lang.String Driver
      The driver is the driving gateway name, sometimes with the provider, separated by ":".
      static java.lang.String Event
      A particular event, in the context of the system or parent path.
      static java.lang.String HistoryProvider  
      static java.lang.String Machine
      The Machine ID of the physical server running Ignition.
      static java.lang.String Project
      Fairly self explanatory.
      static java.lang.String Property  
      static java.lang.String Provider
      Can refer to different types of providers, depends on the following object for context.
      static java.lang.String Source
      The source indicates where a remote event of some kind originated, ideally in a unique way.
      static java.lang.String System
      The id of the particular Ignition
      static java.lang.String Tag
      A path to a tag
      static java.lang.String User  
      static java.lang.String UserProfile  

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • Machine

        public static final java.lang.String Machine
        The Machine ID of the physical server running Ignition.
        See Also:
        Constant Field Values

      • System

        public static final java.lang.String System
        The id of the particular Ignition
        See Also:
        Constant Field Values

      • Event

        public static final java.lang.String Event
        A particular event, in the context of the system or parent path.
        See Also:
        Constant Field Values

      • Provider

        public static final java.lang.String Provider
        Can refer to different types of providers, depends on the following object for context.
        See Also:
        Constant Field Values

      • Driver

        public static final java.lang.String Driver
        The driver is the driving gateway name, sometimes with the provider, separated by ":". In other words: gatewayName[:providerName]
        See Also:
        Constant Field Values

      • Source

        public static final java.lang.String Source
        The source indicates where a remote event of some kind originated, ideally in a unique way.
        See Also:
        Constant Field Values

      • Project

        public static final java.lang.String Project
        Fairly self explanatory. Not often used in paths, but useful for logging.
        See Also:
        Constant Field Values