Class ScanClassDefinition
- java.lang.Object
-
- com.inductiveautomation.ignition.common.sqltags.scanclasses.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
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_HISTORICAL_NAME
static int
DEFAULT_HISTORICAL_RATE
static java.lang.String
DEFAULT_NAME
static int
DEFAULT_RATE
-
Fields inherited from interface com.inductiveautomation.ignition.common.sqltags.model.ScanClass
DEFAULT_STALE_TIMEOUT, FLAG_ONE_SHOT, FLAG_OPC_OPTIMISTIC_WRITE, FLAG_OPC_READ_AFTER_WRITE, FLAG_POLLED_READ
-
-
Constructor Summary
Constructors Constructor Description ScanClassDefinition()
Ctor that sets fields to defaultsScanClassDefinition(ScanClass copy)
Copy ctorScanClassDefinition(java.lang.String name)
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)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static ScanClassDefinition
fromBase64String(java.lang.String str)
ScanClassComparison
getCompareMode()
java.lang.Double
getCompareValue()
java.lang.String
getDrivingTagPath()
Flags
getExecutionFlags()
Flags that dictate special features of execution, such as Polled OPC Reads or One-shot triggering.java.lang.Integer
getHiRate()
HiRate is the "fast" ratejava.lang.Integer
getLoRate()
LoRate is the "slow" rateScanClassMode
getMode()
java.lang.String
getName()
OpcDataMode
getOPCMode()
java.lang.Integer
getStaleTimeout()
Stale timeout in milliseconds.java.lang.Integer
getWriteTimeout()
boolean
isOneShot()
void
setCompareMode(ScanClassComparison comparison)
void
setCompareValue(java.lang.Double compareValue)
void
setDrivingTagPath(java.lang.String drivingTagPath)
void
setExecutionFlags(Flags value)
void
setHiRate(java.lang.Integer hiRate)
void
setLoRate(java.lang.Integer loRate)
void
setMode(ScanClassMode mode)
void
setName(java.lang.String name)
void
setOneShot(boolean value)
void
setOPCMode(OpcDataMode mode)
void
setStaleTimeout(java.lang.Integer staleTimeout)
void
setWriteTimeout(java.lang.Integer writeTimeout)
java.lang.String
toBase64String()
java.lang.String
toString()
-
-
-
Field Detail
-
DEFAULT_RATE
public static final int DEFAULT_RATE
- See Also:
- Constant Field Values
-
DEFAULT_HISTORICAL_RATE
public static final int DEFAULT_HISTORICAL_RATE
- See Also:
- Constant Field Values
-
DEFAULT_NAME
public static final java.lang.String DEFAULT_NAME
- See Also:
- Constant Field Values
-
DEFAULT_HISTORICAL_NAME
public static final java.lang.String DEFAULT_HISTORICAL_NAME
- See Also:
- Constant Field Values
-
-
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 classjava.lang.Object
-
fromBase64String
public static ScanClassDefinition fromBase64String(java.lang.String str)
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
setName
public void setName(java.lang.String name)
-
getMode
public ScanClassMode getMode()
-
setMode
public void setMode(ScanClassMode mode)
-
getLoRate
public java.lang.Integer getLoRate()
Description copied from interface:ScanClass
LoRate is the "slow" rate
-
setLoRate
public void setLoRate(java.lang.Integer loRate)
-
getHiRate
public java.lang.Integer getHiRate()
Description copied from interface:ScanClass
HiRate is the "fast" rate
-
setHiRate
public void setHiRate(java.lang.Integer hiRate)
-
getDrivingTagPath
public java.lang.String getDrivingTagPath()
- Specified by:
getDrivingTagPath
in interfaceScanClass
-
setDrivingTagPath
public void setDrivingTagPath(java.lang.String drivingTagPath)
-
getCompareMode
public ScanClassComparison getCompareMode()
- Specified by:
getCompareMode
in interfaceScanClass
-
setCompareMode
public void setCompareMode(ScanClassComparison comparison)
-
getCompareValue
public java.lang.Double getCompareValue()
- Specified by:
getCompareValue
in interfaceScanClass
-
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 interfaceScanClass
-
setStaleTimeout
public void setStaleTimeout(java.lang.Integer staleTimeout)
-
getOPCMode
public OpcDataMode getOPCMode()
-
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 interfaceScanClass
-
setExecutionFlags
public void setExecutionFlags(Flags value)
-
getWriteTimeout
public java.lang.Integer getWriteTimeout()
- Specified by:
getWriteTimeout
in interfaceScanClass
-
setWriteTimeout
public void setWriteTimeout(java.lang.Integer writeTimeout)
-
-