public class ScanClassDefinition extends java.lang.Object implements ScanClass, java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_HISTORICAL_NAME |
static int |
DEFAULT_HISTORICAL_RATE |
static java.lang.String |
DEFAULT_NAME |
static int |
DEFAULT_RATE |
DEFAULT_STALE_TIMEOUT, FLAG_ONE_SHOT, FLAG_OPC_READ_AFTER_WRITE, FLAG_POLLED_READ
Constructor and Description |
---|
ScanClassDefinition()
Ctor that sets fields to defaults
|
ScanClassDefinition(ScanClass copy)
Copy ctor
|
ScanClassDefinition(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) |
Modifier and Type | Method and 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" rate
|
java.lang.Integer |
getLoRate()
LoRate is the "slow" rate
|
ScanClassMode |
getMode() |
java.lang.String |
getName() |
OPCSubscriptionMode |
getOPCMode() |
java.lang.Integer |
getStaleTimeout()
Stale timeout in milliseconds.
|
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(OPCSubscriptionMode mode) |
void |
setStaleTimeout(java.lang.Integer staleTimeout) |
java.lang.String |
toBase64String() |
java.lang.String |
toString() |
public static final int DEFAULT_RATE
public static final int DEFAULT_HISTORICAL_RATE
public static final java.lang.String DEFAULT_NAME
public static final java.lang.String DEFAULT_HISTORICAL_NAME
public ScanClassDefinition()
public ScanClassDefinition(java.lang.String name)
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)
public ScanClassDefinition(ScanClass copy)
public java.lang.String toBase64String()
public java.lang.String toString()
toString
in class java.lang.Object
public static ScanClassDefinition fromBase64String(java.lang.String str)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public void setName(java.lang.String name)
public ScanClassMode getMode()
public void setMode(ScanClassMode mode)
public java.lang.Integer getLoRate()
ScanClass
public void setLoRate(java.lang.Integer loRate)
public java.lang.Integer getHiRate()
ScanClass
public void setHiRate(java.lang.Integer hiRate)
public java.lang.String getDrivingTagPath()
getDrivingTagPath
in interface ScanClass
public void setDrivingTagPath(java.lang.String drivingTagPath)
public ScanClassComparison getCompareMode()
getCompareMode
in interface ScanClass
public void setCompareMode(ScanClassComparison comparison)
public java.lang.Double getCompareValue()
getCompareValue
in interface ScanClass
public void setCompareValue(java.lang.Double compareValue)
public java.lang.Integer getStaleTimeout()
ScanClass
getStaleTimeout
in interface ScanClass
public void setStaleTimeout(java.lang.Integer staleTimeout)
public OPCSubscriptionMode getOPCMode()
public void setOPCMode(OPCSubscriptionMode mode)
public boolean isOneShot()
public void setOneShot(boolean value)
public Flags getExecutionFlags()
ScanClass
getExecutionFlags
in interface ScanClass
public void setExecutionFlags(Flags value)