Package com.inductiveautomation.ignition.gateway.sqltags.history.query

Enum BlockMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<BlockMode>
    public enum BlockMode
extends java.lang.Enum<BlockMode>

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Defined
      The specified number of data points will be returned.
      Natural
      Data will be returned for each scan class execution.
      Raw
      Data will be returned as it is in the database.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static BlockMode getForReturnSize​(int size)
      Returns the proper enum value for the given return size (each of the values is currently mapped to a requested size)
      static BlockMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BlockMode[] 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

      • Raw

        public static final BlockMode Raw
        Data will be returned as it is in the database.

      • Natural

        public static final BlockMode Natural
        Data will be returned for each scan class execution.

      • Defined

        public static final BlockMode Defined
        The specified number of data points will be returned.

    • Method Detail

      • values

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

      • valueOf

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

      • getForReturnSize

        public static BlockMode getForReturnSize​(int size)
        Returns the proper enum value for the given return size (each of the values is currently mapped to a requested size)