Package com.inductiveautomation.ignition.common.sqltags.history

Enum ReturnFormat

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ReturnFormat>
    public enum ReturnFormat
extends java.lang.Enum<ReturnFormat>
    Specifies how data is returned for history queries.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Calculations
      Column format is fixed at "timestamp, path, calculation1, calculation2, calculation3".
      Tall
      Column format is fixed at "path, value, quality, timestamp".
      Wide
      Each tag is a column, along with a "timestamp" column.

    • Method Summary

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

      • Wide

        public static final ReturnFormat Wide
        Each tag is a column, along with a "timestamp" column.

      • Tall

        public static final ReturnFormat Tall
        Column format is fixed at "path, value, quality, timestamp". All data is returned vertically.

      • Calculations

        public static final ReturnFormat Calculations
        Column format is fixed at "timestamp, path, calculation1, calculation2, calculation3".

    • Method Detail

      • values

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

      • valueOf

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