Interface ScanClass
-
- All Known Implementing Classes:
ScanClassDefinition
public interface ScanClass
Defines the properties of a scan class. NOTE: "ScanClass" used to be the name of the implementing class, which is now BasicScanClass.
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_STALE_TIMEOUT
static int
FLAG_ONE_SHOT
static int
FLAG_OPC_OPTIMISTIC_WRITE
static int
FLAG_OPC_READ_AFTER_WRITE
static int
FLAG_POLLED_READ
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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()
java.lang.Integer
getStaleTimeout()
Stale timeout in milliseconds.java.lang.Integer
getWriteTimeout()
-
-
-
Field Detail
-
DEFAULT_STALE_TIMEOUT
static final int DEFAULT_STALE_TIMEOUT
- See Also:
- Constant Field Values
-
FLAG_ONE_SHOT
static final int FLAG_ONE_SHOT
- See Also:
- Constant Field Values
-
FLAG_POLLED_READ
static final int FLAG_POLLED_READ
- See Also:
- Constant Field Values
-
FLAG_OPC_READ_AFTER_WRITE
static final int FLAG_OPC_READ_AFTER_WRITE
- See Also:
- Constant Field Values
-
FLAG_OPC_OPTIMISTIC_WRITE
static final int FLAG_OPC_OPTIMISTIC_WRITE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
java.lang.String getName()
-
getLoRate
java.lang.Integer getLoRate()
LoRate is the "slow" rate
-
getHiRate
java.lang.Integer getHiRate()
HiRate is the "fast" rate
-
getDrivingTagPath
java.lang.String getDrivingTagPath()
-
getMode
ScanClassMode getMode()
-
getCompareMode
ScanClassComparison getCompareMode()
-
getCompareValue
java.lang.Double getCompareValue()
-
getStaleTimeout
java.lang.Integer getStaleTimeout()
Stale timeout in milliseconds.
-
getExecutionFlags
Flags getExecutionFlags()
Flags that dictate special features of execution, such as Polled OPC Reads or One-shot triggering.
-
getWriteTimeout
java.lang.Integer getWriteTimeout()
-
-