com.inductiveautomation.ignition.gateway.sqltags.scanclasses

Class SimpleExecutableScanClass

java.lang.Object

com.inductiveautomation.ignition.gateway.sqltags.scanclasses.BasicScanClassInstance

com.inductiveautomation.ignition.gateway.sqltags.scanclasses.SimpleExecutableScanClass

All Implemented Interfaces:

Diagnosable, ScanClassStats, ExecutableScanClass, ScanClassInstance, SQLTagsExecutor, TagExecutor, java.lang.Runnable

Direct Known Subclasses:

MultiDriverExecutableScanClass

public class SimpleExecutableScanClass
extends BasicScanClassInstance
implements java.lang.Runnable, ExecutableScanClass

Represents a scan class instance that actually gets executed by a provider. It extends from ScanClassInstance- whose functionality is used to manage the tags, stats, etc. pertaining to the tags *actually* executed by this instance.

The simple executable scan class doesn't care about driver names. That's what the MultiDriverExecSC is for.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SimpleExecutableScanClass.DrivenTagListener
protected class	SimpleExecutableScanClass.ScanClassTagEvaluationContext The scan class eval context processes most things immediately (inheriting from DirectTagEvaluationContext ), except history.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	FLAG_IS_TRANSFER
protected static int	FLAG_PREVENT_INIT
protected static int	FLAG_RELEASE_ALARMS
protected static int	FLAG_SEND_ALARM_DEREG
protected static int	FLAG_SET_BAD_QUALITY
protected org.apache.log4j.Logger	log
protected ScanclassListener	scListener

Constructor Summary

Constructors

Constructor and Description
SimpleExecutableScanClass(ScanClass scDefinition, java.lang.String driverName, EntityId id)

Method Summary

Modifier and Type	Method and Description
void	addTags(java.util.Collection<ExecutableTag> tags) Adds the tags to the scan class and initializes them.
protected void	addTags(java.util.Collection<ExecutableTag> tags, Flags initFlags) Adds tags to the scan class, but only initializes them if doInit is true.
ExpressionParseContext	createExpressionParseContext(TagPath owningTag) Creates a parse context to be used by the owning tag to parse references.
protected SimpleExecutableScanClass.ScanClassTagEvaluationContext	createTagEvalContext()
protected int	getCurrentUpdateRate()
java.lang.String	getDefaultDatasource()
java.lang.String	getDefaultTagSource() Returns the default tag source to be used when parsing tag reference paths.
protected int	getDesiredUpdateRate() Calculates the appropriate update rate for this scan class.
java.lang.String	getDisplayNameForPath(TagPath path) Returns a friendly, fully qualified path for the given tag.
EntityId	getEntityId()
TagEvaluationContext	getEvaluationContext()
FunctionFactory	getExpressionFunctionFactory()
GatewayContext	getGatewayContext()
java.util.Date	getLastEvaluationTime() The last time the executor tried to run the tags.
java.lang.String	getName()
protected java.lang.String	getNameForExecUnit()
QualifiedPath	getObjectPath()
java.lang.String	getOpcSubscriptionName() Returns a subscription name for use with the OPC system.
SQLTagsExecutor	getOwner()
protected java.lang.String	getOwnerNameForExecUnit() The name to use for the "owner" field of any execution units.
ScriptManager	getScriptManager() Returns the ScriptManager that can be used to execute Python scripts.
java.util.List<BasicInformation>	getStatusInformation()
org.apache.log4j.Logger	getTagErrorLogger()
protected SimpleExecutableScanClass.ScanClassTagEvaluationContext	getTagEvalContext()
TagManagerBase	getTagManager() Returns a tagmanagerbase that can be used to look up tag references.
TagScriptManager	getTagScriptManager()
protected void	initializeTags(java.util.Collection<ExecutableTag> tags, Flags flags)
boolean	isAsyncExec() Indicates whether the tags should execute asynchronously, whenever they can, or wait until evaluate is called.
protected boolean	isDrivingTagConditionHigh()
protected boolean	isOnChange()
protected boolean	isOneShot()
protected boolean	isPolledRead() Returns whether we should read, instead of subscribed.
protected void	notifyRateChange()
protected void	notifyStatistics()
protected void	processHistory(java.util.Map<java.lang.String,? extends HistoricalData> histValues)
protected void	processInitContext(TagInitializationContext context)
protected void	processTagContext(TagContext context) The tagcontext base contains error messages for the tag.
protected void	processUninitContext(TagUninitializeContext context)
void	removeTags(java.util.Collection<ExecutableTag> tags, boolean deleted) Removes the tags from the scan class.
protected void	removeTags(java.util.Collection<ExecutableTag> tags, Flags flags)
protected void	reportDebug(java.lang.String msg)
void	run() Executes the scan class instance, processing all tags it contains.
protected boolean	runTagEvaluation() Actually evaluates tags, returns whether they ran or not.
void	sampleDiagnostics(DiagnosticsSample sample) Provides the sample upon which the object can set diagnostics information.
protected void	setCurrentUpdateRate(int ms) Setting this will change the rate at which the scan class executes.
protected void	setDrivingTagPath(TagPath path) Updates the driving tag reference of the scan class.
void	setOwner(SQLTagsExecutor owner)
void	setScanClass(ScanClass scanClass)
void	setScanclassListener(ScanclassListener listener)
protected boolean	shouldRunRegularly() Returns whether the scan class should be registered with the exec engine and run regularly.
void	startExecution() Begin executing this scan class instance.
void	stopExecution() Stop executing this scan class instance, unregisters the timer and the opc subscription.
protected void	stopExecution(boolean stopOPCSub)
void	transferExecution(ExecutableScanClass target) This function transfers all of its running state to the new scan class that's going to take over for it.
protected void	uninitializeTags(java.util.Collection<ExecutableTag> tags, Flags flags) This version is used to give subclasses chance to set the parameters we want on the tag uninit context before we call in.
protected void	updateDrivingTag()
void	updateInstanceInfo(ScanClassInstance instance)
void	updateLease(long expirationMillis) Sets the time, as a long, when the lease will expire.
protected void	updateNextExec()
protected void	updateStatMetrics(java.util.Map<java.lang.String,StatMetric> statMetrics) Gives sub classes the opportunity to add their own stat metrics onto the map that will be returned to getStatusInformation.
protected void	updateStatusProperties(java.util.List<NamedValue> properties) Gives the chance to add properties onto the list that will be returned to the call to getStatusInformation.
boolean	useOPCReadAfterWrite() If true, opc values should be updated by reading immediately after they write.

Methods inherited from class com.inductiveautomation.ignition.gateway.sqltags.scanclasses.BasicScanClassInstance

addAllTagPaths, addHistoricalTags, copyStats, evaluateStaleness, evaluateTags, getAvgExecDuration, getCurrentHistTagSet, getCurrentTagSet, getDriverName, getExecCount, getHistoricalTags, getHistoryProviderSet, getLastExec, getLastExecDBReads, getLastExecDBWrites, getLastExecDelay, getLastExecDuration, getLastExecOPCReads, getLastExecOPCWrites, getLastExecRate, getNextExec, getScanClass, getTags, internalAddTags, isStale, removeHistoricalTags, removeTags, resetTagEvaluation, setAvgExecDuration, setDriverName, setExecCount, setLastExec, setLastExecDBReads, setLastExecDBWrites, setLastExecDelay, setLastExecDuration, setLastExecOPCReads, setLastExecOPCWrites, setLastExecRate, setNextExec, setStale, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.gateway.sqltags.model.ExecutableScanClass

addHistoricalTags, getHistoricalTags, getScanClass, getTags, removeHistoricalTags

Methods inherited from interface com.inductiveautomation.ignition.gateway.sqltags.model.SQLTagsExecutor

getExecutionManager

Methods inherited from interface com.inductiveautomation.ignition.gateway.sqltags.model.ScanClassInstance

copyStats, getAvgExecDuration, getDriverName, getExecCount, getLastExec, getLastExecDBReads, getLastExecDBWrites, getLastExecDelay, getLastExecDuration, getLastExecOPCReads, getLastExecOPCWrites, getLastExecRate, getNextExec, isStale

Field Detail

FLAG_SEND_ALARM_DEREG

protected static final int FLAG_SEND_ALARM_DEREG

See Also:

Constant Field Values

FLAG_IS_TRANSFER

protected static final int FLAG_IS_TRANSFER

See Also:

Constant Field Values

FLAG_PREVENT_INIT

protected static final int FLAG_PREVENT_INIT

See Also:

Constant Field Values

FLAG_SET_BAD_QUALITY

protected static final int FLAG_SET_BAD_QUALITY

See Also:

Constant Field Values

FLAG_RELEASE_ALARMS

protected static final int FLAG_RELEASE_ALARMS

See Also:

Constant Field Values

scListener

protected ScanclassListener scListener

log

protected org.apache.log4j.Logger log

Constructor Detail

SimpleExecutableScanClass

public SimpleExecutableScanClass(ScanClass scDefinition,
                                 java.lang.String driverName,
                                 EntityId id)

Method Detail

useOPCReadAfterWrite

public boolean useOPCReadAfterWrite()

Description copied from interface: TagExecutor

If true, opc values should be updated by reading immediately after they write.

Specified by:

useOPCReadAfterWrite in interface TagExecutor

Returns:

getOwner

public SQLTagsExecutor getOwner()

Specified by:

getOwner in interface ExecutableScanClass

getTagScriptManager

public TagScriptManager getTagScriptManager()

Specified by:

getTagScriptManager in interface SQLTagsExecutor

getObjectPath

public QualifiedPath getObjectPath()

Specified by:

getObjectPath in interface SQLTagsExecutor

setOwner

public void setOwner(SQLTagsExecutor owner)

Specified by:

setOwner in interface ExecutableScanClass

isPolledRead

protected boolean isPolledRead()

Returns whether we should read, instead of subscribed. Returns the set option, or TRUE if we're in a non-regular execution mode (one shot, on change).

isOneShot

protected boolean isOneShot()

isOnChange

protected boolean isOnChange()

shouldRunRegularly

protected boolean shouldRunRegularly()

Returns whether the scan class should be registered with the exec engine and run regularly.

Returns:

getEntityId

public EntityId getEntityId()

Specified by:

getEntityId in interface ExecutableScanClass

getExpressionFunctionFactory

public FunctionFactory getExpressionFunctionFactory()

Specified by:

getExpressionFunctionFactory in interface TagExecutor

getLastEvaluationTime

public java.util.Date getLastEvaluationTime()

Description copied from interface: TagExecutor

The last time the executor tried to run the tags. Could be expanded into more diagnostics in the future.

Specified by:

getLastEvaluationTime in interface TagExecutor

Returns:

getDefaultTagSource

public java.lang.String getDefaultTagSource()

Description copied from interface: SQLTagsExecutor

Returns the default tag source to be used when parsing tag reference paths. If null, the project default tag source will be used.

Specified by:

getDefaultTagSource in interface SQLTagsExecutor

Returns:

getDisplayNameForPath

public java.lang.String getDisplayNameForPath(TagPath path)

Description copied from interface: SQLTagsExecutor

Returns a friendly, fully qualified path for the given tag.

Specified by:

getDisplayNameForPath in interface SQLTagsExecutor

Returns:

getStatusInformation

public java.util.List<BasicInformation> getStatusInformation()

Specified by:

getStatusInformation in interface ExecutableScanClass

updateStatusProperties

protected void updateStatusProperties(java.util.List<NamedValue> properties)

Gives the chance to add properties onto the list that will be returned to the call to getStatusInformation.

Parameters:

properties -

sampleDiagnostics

public void sampleDiagnostics(DiagnosticsSample sample)

Description copied from interface: Diagnosable

Provides the sample upon which the object can set diagnostics information. It is expected that the calling object will first call getSubSample() in order to specify a useful identifier for this object's data.

Specified by:

sampleDiagnostics in interface Diagnosable

updateStatMetrics

protected void updateStatMetrics(java.util.Map<java.lang.String,StatMetric> statMetrics)

Gives sub classes the opportunity to add their own stat metrics onto the map that will be returned to getStatusInformation. The key of the map is the bundle key of the description.

Parameters:

statMetrics -

getOwnerNameForExecUnit

protected java.lang.String getOwnerNameForExecUnit()

The name to use for the "owner" field of any execution units.

Returns:

getNameForExecUnit

protected java.lang.String getNameForExecUnit()

createTagEvalContext

protected SimpleExecutableScanClass.ScanClassTagEvaluationContext createTagEvalContext()

getTagEvalContext

protected SimpleExecutableScanClass.ScanClassTagEvaluationContext getTagEvalContext()

getEvaluationContext

public TagEvaluationContext getEvaluationContext()

Specified by:

getEvaluationContext in interface TagExecutor

isAsyncExec

public boolean isAsyncExec()

Description copied from interface: TagExecutor

Indicates whether the tags should execute asynchronously, whenever they can, or wait until evaluate is called.

Specified by:

isAsyncExec in interface TagExecutor

Returns:

getTagErrorLogger

public org.apache.log4j.Logger getTagErrorLogger()

Specified by:

getTagErrorLogger in interface SQLTagsExecutor

getGatewayContext

public GatewayContext getGatewayContext()

Specified by:

getGatewayContext in interface SQLTagsExecutor

getTagManager

public TagManagerBase getTagManager()

Description copied from interface: SQLTagsExecutor

Returns a tagmanagerbase that can be used to look up tag references. TagManagerBase might not be the right interface to return here, we really just want getTag, and subscribe.

Specified by:

getTagManager in interface SQLTagsExecutor

Returns:

getScriptManager

public ScriptManager getScriptManager()

Description copied from interface: SQLTagsExecutor

Returns the ScriptManager that can be used to execute Python scripts. We have this here because some SQLTags may operate under a project context, when others don't.

Specified by:

getScriptManager in interface SQLTagsExecutor

getDefaultDatasource

public java.lang.String getDefaultDatasource()

Specified by:

getDefaultDatasource in interface SQLTagsExecutor

setScanclassListener

public void setScanclassListener(ScanclassListener listener)

Specified by:

setScanclassListener in interface ExecutableScanClass

addTags

public void addTags(java.util.Collection<ExecutableTag> tags)

Description copied from interface: ExecutableScanClass

Adds the tags to the scan class and initializes them.

Specified by:

addTags in interface ExecutableScanClass

addTags

protected void addTags(java.util.Collection<ExecutableTag> tags,
                       Flags initFlags)

Adds tags to the scan class, but only initializes them if doInit is true. Not initializing would be desirable if we were transferring already initialized tags.

Parameters:

tags -

doInit -

removeTags

public void removeTags(java.util.Collection<ExecutableTag> tags,
                       boolean deleted)

Description copied from interface: ExecutableScanClass

Removes the tags from the scan class. If deleted, certain things will occur, such as the sending of alarm deregistration messages.

Specified by:

removeTags in interface ExecutableScanClass

removeTags

protected void removeTags(java.util.Collection<ExecutableTag> tags,
                          Flags flags)

initializeTags

protected void initializeTags(java.util.Collection<ExecutableTag> tags,
                              Flags flags)

uninitializeTags

protected void uninitializeTags(java.util.Collection<ExecutableTag> tags,
                                Flags flags)

This version is used to give subclasses chance to set the parameters we want on the tag uninit context before we call in. ProcessUninitContext() will be called at the end of this.

Parameters:

tags -

tagWasDeleted -

context -

notifyRateChange

protected void notifyRateChange()

notifyStatistics

protected void notifyStatistics()

getOpcSubscriptionName

public java.lang.String getOpcSubscriptionName()

Returns a subscription name for use with the OPC system.

Specified by:

getOpcSubscriptionName in interface ExecutableScanClass

Specified by:

getOpcSubscriptionName in interface TagExecutor

Returns:

getName

public java.lang.String getName()

Specified by:

getName in interface ExecutableScanClass

Specified by:

getName in interface SQLTagsExecutor

setScanClass

public void setScanClass(ScanClass scanClass)

Overrides:

setScanClass in class BasicScanClassInstance

updateDrivingTag

protected void updateDrivingTag()

setDrivingTagPath

protected void setDrivingTagPath(TagPath path)

Updates the driving tag reference of the scan class. Will de-initialize the previous reference, so it can be called with null to clean up, if desired.

Parameters:

obj -

setCurrentUpdateRate

protected void setCurrentUpdateRate(int ms)

Setting this will change the rate at which the scan class executes.

Parameters:

ms -

getCurrentUpdateRate

protected int getCurrentUpdateRate()

updateNextExec

protected void updateNextExec()

getDesiredUpdateRate

protected int getDesiredUpdateRate()

Calculates the appropriate update rate for this scan class. Usually passed into setCurrentUpdateRate in order to re-evaluate what rate the sci should run at. It is also used for the OPC subscription rate, so it still returns a value, even if the scan class might not actually evaluate at that rate (for example, in one-shot mode).

Returns:

isDrivingTagConditionHigh

protected boolean isDrivingTagConditionHigh()

updateLease

public void updateLease(long expirationMillis)

Description copied from interface: ExecutableScanClass

Sets the time, as a long, when the lease will expire. Can be set in the past to stop the lease immediately. Won't have an affect on non-leased scan classes.

Specified by:

updateLease in interface ExecutableScanClass

startExecution

public void startExecution()

Begin executing this scan class instance.

Specified by:

startExecution in interface ExecutableScanClass

stopExecution

public void stopExecution()

Stop executing this scan class instance, unregisters the timer and the opc subscription.

Specified by:

stopExecution in interface ExecutableScanClass

stopExecution

protected void stopExecution(boolean stopOPCSub)

runTagEvaluation

protected boolean runTagEvaluation()

Actually evaluates tags, returns whether they ran or not.

Overrides:

runTagEvaluation in class BasicScanClassInstance

Parameters:

evalContext -

Returns:

processTagContext

protected void processTagContext(TagContext context)

The tagcontext base contains error messages for the tag. We'll record them to the proper location.

Parameters:

context -

processUninitContext

protected void processUninitContext(TagUninitializeContext context)

processInitContext

protected void processInitContext(TagInitializationContext context)

transferExecution

public void transferExecution(ExecutableScanClass target)

This function transfers all of its running state to the new scan class that's going to take over for it.

Specified by:

transferExecution in interface ExecutableScanClass

run

public void run()

Executes the scan class instance, processing all tags it contains.

Specified by:

run in interface java.lang.Runnable

processHistory

protected void processHistory(java.util.Map<java.lang.String,? extends HistoricalData> histValues)

reportDebug

protected void reportDebug(java.lang.String msg)

updateInstanceInfo

public void updateInstanceInfo(ScanClassInstance instance)

Specified by:

updateInstanceInfo in interface ExecutableScanClass

createExpressionParseContext

public ExpressionParseContext createExpressionParseContext(TagPath owningTag)

Description copied from interface: TagExecutor

Creates a parse context to be used by the owning tag to parse references. Owning tag will be used for relative dereference, and also to detect reflective references.

Specified by:

createExpressionParseContext in interface TagExecutor

Returns: