Class ScanClassDefinition

  • All Implemented Interfaces:
    ScanClass, java.io.Serializable

    public class ScanClassDefinition
    extends java.lang.Object
    implements ScanClass, java.io.Serializable
    Represents a scan class, and is easily serializable for messaging
    See Also:
    Serialized Form
    • Constructor Detail

      • ScanClassDefinition

        public ScanClassDefinition()
        Ctor that sets fields to defaults
      • ScanClassDefinition

        public ScanClassDefinition​(java.lang.String name)
      • ScanClassDefinition

        public ScanClassDefinition​(java.lang.String name,
                                   ScanClassMode mode,
                                   int loRate,
                                   int hiRate,
                                   java.lang.String drivingTagPath,
                                   ScanClassComparison comparison,
                                   double compareValue,
                                   java.lang.Integer staleTimeout,
                                   Flags execFlags,
                                   java.lang.Integer writeTimeout)
      • ScanClassDefinition

        public ScanClassDefinition​(ScanClass copy)
        Copy ctor
    • Method Detail

      • toBase64String

        public java.lang.String toBase64String()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • fromBase64String

        public static ScanClassDefinition fromBase64String​(java.lang.String str)
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface ScanClass
      • setName

        public void setName​(java.lang.String name)
      • getLoRate

        public java.lang.Integer getLoRate()
        Description copied from interface: ScanClass
        LoRate is the "slow" rate
        Specified by:
        getLoRate in interface ScanClass
      • setLoRate

        public void setLoRate​(java.lang.Integer loRate)
      • getHiRate

        public java.lang.Integer getHiRate()
        Description copied from interface: ScanClass
        HiRate is the "fast" rate
        Specified by:
        getHiRate in interface ScanClass
      • setHiRate

        public void setHiRate​(java.lang.Integer hiRate)
      • setDrivingTagPath

        public void setDrivingTagPath​(java.lang.String drivingTagPath)
      • setCompareValue

        public void setCompareValue​(java.lang.Double compareValue)
      • getStaleTimeout

        public java.lang.Integer getStaleTimeout()
        Description copied from interface: ScanClass
        Stale timeout in milliseconds.
        Specified by:
        getStaleTimeout in interface ScanClass
      • setStaleTimeout

        public void setStaleTimeout​(java.lang.Integer staleTimeout)
      • setOPCMode

        public void setOPCMode​(OpcDataMode mode)
      • isOneShot

        public boolean isOneShot()
      • setOneShot

        public void setOneShot​(boolean value)
      • getExecutionFlags

        public Flags getExecutionFlags()
        Description copied from interface: ScanClass
        Flags that dictate special features of execution, such as Polled OPC Reads or One-shot triggering.
        Specified by:
        getExecutionFlags in interface ScanClass
      • setExecutionFlags

        public void setExecutionFlags​(Flags value)
      • setWriteTimeout

        public void setWriteTimeout​(java.lang.Integer writeTimeout)