Package com.inductiveautomation.ignition.common.sqltags.scanclasses

Class ScanClassDefinition

java.lang.Object

com.inductiveautomation.ignition.common.sqltags.scanclasses.ScanClassDefinition

All Implemented Interfaces:

ScanClass, Serializable

public class ScanClassDefinition
extends Object
implements ScanClass, Serializable

Represents a scan class, and is easily serializable for messaging

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_HISTORICAL_NAME
static final int	DEFAULT_HISTORICAL_RATE
static final String	DEFAULT_NAME
static final 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 defaults
ScanClassDefinition(ScanClass copy)	Copy ctor
ScanClassDefinition(String name)
ScanClassDefinition(String name, ScanClassMode mode, int loRate, int hiRate, String drivingTagPath, ScanClassComparison comparison, double compareValue, Integer staleTimeout, Flags execFlags, Integer writeTimeout)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
ScanClassComparison	getCompareMode()
Double	getCompareValue()
String	getDrivingTagPath()
Flags	getExecutionFlags()	Flags that dictate special features of execution, such as Polled OPC Reads or One-shot triggering.
Integer	getHiRate()	HiRate is the "fast" rate
Integer	getLoRate()	LoRate is the "slow" rate
ScanClassMode	getMode()
String	getName()
OpcDataMode	getOPCMode()
Integer	getStaleTimeout()	Stale timeout in milliseconds.
Integer	getWriteTimeout()
boolean	isOneShot()
void	setCompareMode(ScanClassComparison comparison)
void	setCompareValue(Double compareValue)
void	setDrivingTagPath(String drivingTagPath)
void	setExecutionFlags(Flags value)
void	setHiRate(Integer hiRate)
void	setLoRate(Integer loRate)
void	setMode(ScanClassMode mode)
void	setName(String name)
void	setOneShot(boolean value)
void	setOPCMode(OpcDataMode mode)
void	setStaleTimeout(Integer staleTimeout)
void	setWriteTimeout(Integer writeTimeout)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

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 String DEFAULT_NAME

See Also:

• Constant Field Values

DEFAULT_HISTORICAL_NAME

public static final String DEFAULT_HISTORICAL_NAME

See Also:

• Constant Field Values

Constructor Details

ScanClassDefinition

public ScanClassDefinition()

Ctor that sets fields to defaults

ScanClassDefinition

public ScanClassDefinition(String name)

ScanClassDefinition

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

ScanClassDefinition

public ScanClassDefinition(ScanClass copy)

Copy ctor

Method Details

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getName

public String getName()

Specified by:

getName in interface ScanClass

setName

public void setName(String name)

getMode

public ScanClassMode getMode()

Specified by:

getMode in interface ScanClass

setMode

public void setMode(ScanClassMode mode)

getLoRate

public Integer getLoRate()

Description copied from interface: ScanClass

LoRate is the "slow" rate

Specified by:

getLoRate in interface ScanClass

setLoRate

public void setLoRate(Integer loRate)

getHiRate

public Integer getHiRate()

Description copied from interface: ScanClass

HiRate is the "fast" rate

Specified by:

getHiRate in interface ScanClass

setHiRate

public void setHiRate(Integer hiRate)

getDrivingTagPath

public String getDrivingTagPath()

Specified by:

getDrivingTagPath in interface ScanClass

setDrivingTagPath

public void setDrivingTagPath(String drivingTagPath)

getCompareMode

public ScanClassComparison getCompareMode()

Specified by:

getCompareMode in interface ScanClass

setCompareMode

public void setCompareMode(ScanClassComparison comparison)

getCompareValue

public Double getCompareValue()

Specified by:

getCompareValue in interface ScanClass

setCompareValue

public void setCompareValue(Double compareValue)

getStaleTimeout

public Integer getStaleTimeout()

Description copied from interface: ScanClass

Stale timeout in milliseconds.

Specified by:

getStaleTimeout in interface ScanClass

setStaleTimeout

public void setStaleTimeout(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 interface ScanClass

setExecutionFlags

public void setExecutionFlags(Flags value)

getWriteTimeout

public Integer getWriteTimeout()

Specified by:

getWriteTimeout in interface ScanClass

setWriteTimeout

public void setWriteTimeout(Integer writeTimeout)