com.inductiveautomation.ignition.gateway.sqltags.execution.tags

Class DisabledTag

java.lang.Object

com.inductiveautomation.ignition.gateway.sqltags.execution.tags.AbstractGatewayTag

com.inductiveautomation.ignition.gateway.sqltags.execution.tags.DisabledTag

All Implemented Interfaces:

Diagnosable, Tag, TagObject, ExecutableTag, GatewayTag, java.lang.Comparable<Tag>

public class DisabledTag
extends AbstractGatewayTag

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.sqltags.execution.tags.AbstractGatewayTag

RUNTIME_PROPERTIES, tagChangeListener

Constructor Summary

Constructors

Constructor and Description
DisabledTag()

Method Summary

Modifier and Type	Method and Description
void	configure(Tag def)
void	evaluate() Evaluates the tag for any outstanding changes.
void	evaluateHistory(TagEvaluationContext context)
AccessRightsType	getAccessRights() Gets the type of access rights for this tag
AlarmConfiguration	getAlarmStates() Returns the list of alarm states for this tag
TagValue	getAttribute(TagProp prop) Subclasses can override this to provide more efficient or complete implementations.
DataType	getDataType() Returns the datatype of this tag's value property
TagExecutor	getExecutor()
TagPermissionsModel	getPermissionModel() Returns this tags permission model, if any
protected org.apache.log4j.Logger	getTagLogger()
TagType	getType() Returns the type of this tag.
TagValue	getValue() Returns the value in qualified form- along with quality and timestamp.
void	initialize(TagInitializationContext context) ExecutableTag
boolean	isAlarmingSupported() Returns true if this tag supports alarming, false otherwise
boolean	isEnabled() Returns the enabled bit for this tag
boolean	isEvaluated()
boolean	isWritable() Returns whether or not a tag can be written to.
void	resetEvaluation()
void	sampleDiagnostics(DiagnosticsSample sample) Provides the sample upon which the object can set diagnostics information.
void	setExecutor(TagExecutor value)
boolean	supportsCurrentValueUpdate() Returns whether the current value can be set directly.
void	unInitialize(TagUninitializeContext context)
void	updateCurrentValue(TagValue value) Updates the current value, if supportsCurrentValueUpdate is true.
void	write(TagWriteContext context, AsyncWriteRequest<TagPath> value) This function can be called at any time to write a value to the tag.

Methods inherited from class com.inductiveautomation.ignition.gateway.sqltags.execution.tags.AbstractGatewayTag

compareTo, createTagChangeEvent, fireChangeEvent, fireChangeEvent, getConfigProvider, getEntityId, getEventScripts, getName, getTagChangeListener, getTagPath, setConfigProvider, setEntityId, setTagChangeListener, setTagChangeListener, setTagPath

Methods inherited from class java.lang.Object

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

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

setAttribute

Constructor Detail

DisabledTag

public DisabledTag()

Method Detail

getTagLogger

protected org.apache.log4j.Logger getTagLogger()

Overrides:

getTagLogger in class AbstractGatewayTag

configure

public void configure(Tag def)

Overrides:

configure in class AbstractGatewayTag

getAttribute

public TagValue getAttribute(TagProp prop)

Description copied from class: AbstractGatewayTag

Subclasses can override this to provide more efficient or complete implementations.

Specified by:

getAttribute in interface Tag

Overrides:

getAttribute in class AbstractGatewayTag

Returns:

initialize

public void initialize(TagInitializationContext context)

Description copied from interface: ExecutableTag

ExecutableTag

unInitialize

public void unInitialize(TagUninitializeContext context)

setExecutor

public void setExecutor(TagExecutor value)

Specified by:

setExecutor in interface ExecutableTag

Overrides:

setExecutor in class AbstractGatewayTag

getExecutor

public TagExecutor getExecutor()

Specified by:

getExecutor in interface ExecutableTag

Overrides:

getExecutor in class AbstractGatewayTag

isEvaluated

public boolean isEvaluated()

resetEvaluation

public void resetEvaluation()

evaluate

public void evaluate()

Description copied from interface: ExecutableTag

Evaluates the tag for any outstanding changes.

evaluateHistory

public void evaluateHistory(TagEvaluationContext context)

isWritable

public boolean isWritable()

Description copied from interface: ExecutableTag

Returns whether or not a tag can be written to.

Returns:

supportsCurrentValueUpdate

public boolean supportsCurrentValueUpdate()

Description copied from interface: ExecutableTag

Returns whether the current value can be set directly.

Returns:

updateCurrentValue

public void updateCurrentValue(TagValue value)

Description copied from interface: ExecutableTag

Updates the current value, if supportsCurrentValueUpdate is true. The value may or may not take hold immediately- the tag may wait until the next execution to actually evaluate the value.

write

public void write(TagWriteContext context,
                  AsyncWriteRequest<TagPath> value)

Description copied from interface: ExecutableTag

This function can be called at any time to write a value to the tag.

value - WriteValue to be used. The function can set the write value response right away to indicate the write has be completed, or it can process it and pass it on to the context or some other function.

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.

getType

public TagType getType()

Description copied from interface: Tag

Returns the type of this tag.

Returns:

getDataType

public DataType getDataType()

Description copied from interface: Tag

Returns the datatype of this tag's value property

Returns:

isEnabled

public boolean isEnabled()

Description copied from interface: Tag

Returns the enabled bit for this tag

Returns:

getValue

public TagValue getValue()

Description copied from interface: Tag

Returns the value in qualified form- along with quality and timestamp.

Returns:

getAccessRights

public AccessRightsType getAccessRights()

Description copied from interface: Tag

Gets the type of access rights for this tag

Returns:

getPermissionModel

public TagPermissionsModel getPermissionModel()

Description copied from interface: Tag

Returns this tags permission model, if any

Returns:

getAlarmStates

public AlarmConfiguration getAlarmStates()

Description copied from interface: Tag

Returns the list of alarm states for this tag

Specified by:

getAlarmStates in interface Tag

Overrides:

getAlarmStates in class AbstractGatewayTag

isAlarmingSupported

public boolean isAlarmingSupported()

Description copied from interface: Tag

Returns true if this tag supports alarming, false otherwise

Returns: