com.inductiveautomation.ignition.client.script

Class ClientTagUtilities

java.lang.Object

com.inductiveautomation.ignition.common.script.builtin.AbstractTagUtilities

com.inductiveautomation.ignition.client.script.ClientTagUtilities

public class ClientTagUtilities
extends AbstractTagUtilities

Adds client-style tag writing

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractTagUtilities

AbstractTagUtilities.DateRange

Field Summary

Fields inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractTagUtilities

tagManager

Constructor Summary

Constructors

Constructor and Description
ClientTagUtilities(ClientContext context)

Method Summary

Modifier and Type	Method and Description
TagConfigSet	browseConfiguration(java.lang.String path, boolean recursive)
protected BrowseResults	browseHistoricalTagsImpl(QualifiedPath path, BrowseFilter filter)
protected boolean	canEditForProvider(java.lang.String provider)
protected void	configureImpl(java.lang.String path, TagConfigSet cfg, TagManagerBase.CollisionPolicy policy)
protected java.util.List<TagValue>	getTagValuesImpl(java.util.List<TagPath> paths) Bulk implementation of retrieving tag values.
protected TypeManager	getTypeManager(java.lang.String provider)
protected Dataset	queryTagCalculationsImpl(java.util.List<QualifiedPath> paths, java.util.List<Aggregate> colAggModes, java.util.Date startDate, java.util.Date endDate, java.util.List<java.lang.String> aliases, Flags queryFlags)
protected Dataset	queryTagDensityImpl(java.util.List<QualifiedPath> paths, java.util.Date startDate, java.util.Date endDate)
protected Dataset	queryTagHistoryImpl(java.util.List<QualifiedPath> paths, java.util.Date startDate, java.util.Date endDate, int returnSize, Aggregate aggregationMode, ReturnFormat format, java.util.List<java.lang.String> aliases, java.util.List<Aggregate> columnAggModes, Flags queryFlags, int timeout)
protected void	scanImpl(java.lang.String provider, java.lang.String scname)
protected QualifiedPath	toQualifiedPathFromHistoricalString(java.lang.String path)
protected int	writeToTagImpl(TagPath path, java.lang.Object value, boolean suppressErrors) Writes a value to a tag.
protected int[]	writeToTagsImpl(java.util.List<TagPath> paths, java.util.List<java.lang.Object> values) Bulk implementation of writing to tags.
protected void	writeToTagsSynchronousImpl(java.util.List<TagPath> paths, java.util.List<java.lang.Object> values, int timeout)
protected void	writeToTagSynchronousImpl(TagPath path, java.lang.Object value, int timeout)

Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractTagUtilities

adjustPath, browseHistoricalTags, configure, exists, getAggregateFor, getTag, getTagManager, getTagValue, getTagValues, interpretRange, loadFromFile, parseTagPath, queryTagCalculations, queryTagDensity, queryTagHistory, read, readAll, scan, toConfigSet, write, writeAll, writeAllSynchronous, writeAllSynchronous, writeSynchronous, writeSynchronous, writeToTag, writeToTag, writeToTags, writeToTagSynchronous, writeToTagSynchronous

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientTagUtilities

public ClientTagUtilities(ClientContext context)

Method Detail

getTypeManager

protected TypeManager getTypeManager(java.lang.String provider)

Specified by:

getTypeManager in class AbstractTagUtilities

canEditForProvider

protected boolean canEditForProvider(java.lang.String provider)

Specified by:

canEditForProvider in class AbstractTagUtilities

scanImpl

protected void scanImpl(java.lang.String provider,
                        java.lang.String scname)

Specified by:

scanImpl in class AbstractTagUtilities

browseHistoricalTagsImpl

protected BrowseResults browseHistoricalTagsImpl(QualifiedPath path,
                                                 BrowseFilter filter)

Specified by:

browseHistoricalTagsImpl in class AbstractTagUtilities

writeToTagImpl

protected int writeToTagImpl(TagPath path,
                             java.lang.Object value,
                             boolean suppressErrors)

Writes a value to a tag. Returns:

• 0: write failed.
• 1: write succeeded.
• 2: Write pending

Specified by:

writeToTagImpl in class AbstractTagUtilities

writeToTagSynchronousImpl

protected void writeToTagSynchronousImpl(TagPath path,
                                         java.lang.Object value,
                                         int timeout)

Specified by:

writeToTagSynchronousImpl in class AbstractTagUtilities

writeToTagsSynchronousImpl

protected void writeToTagsSynchronousImpl(java.util.List<TagPath> paths,
                                          java.util.List<java.lang.Object> values,
                                          int timeout)
                                   throws java.lang.Exception

Specified by:

writeToTagsSynchronousImpl in class AbstractTagUtilities

Throws:

java.lang.Exception

toQualifiedPathFromHistoricalString

protected QualifiedPath toQualifiedPathFromHistoricalString(java.lang.String path)

Overrides:

toQualifiedPathFromHistoricalString in class AbstractTagUtilities

queryTagHistoryImpl

protected Dataset queryTagHistoryImpl(java.util.List<QualifiedPath> paths,
                                      java.util.Date startDate,
                                      java.util.Date endDate,
                                      int returnSize,
                                      Aggregate aggregationMode,
                                      ReturnFormat format,
                                      java.util.List<java.lang.String> aliases,
                                      java.util.List<Aggregate> columnAggModes,
                                      Flags queryFlags,
                                      int timeout)
                               throws java.lang.Exception

Specified by:

queryTagHistoryImpl in class AbstractTagUtilities

Throws:

java.lang.Exception

queryTagCalculationsImpl

protected Dataset queryTagCalculationsImpl(java.util.List<QualifiedPath> paths,
                                           java.util.List<Aggregate> colAggModes,
                                           java.util.Date startDate,
                                           java.util.Date endDate,
                                           java.util.List<java.lang.String> aliases,
                                           Flags queryFlags)
                                    throws java.lang.Exception

Specified by:

queryTagCalculationsImpl in class AbstractTagUtilities

Throws:

java.lang.Exception

queryTagDensityImpl

protected Dataset queryTagDensityImpl(java.util.List<QualifiedPath> paths,
                                      java.util.Date startDate,
                                      java.util.Date endDate)
                               throws java.lang.Exception

Specified by:

queryTagDensityImpl in class AbstractTagUtilities

Throws:

java.lang.Exception

getTagValuesImpl

protected java.util.List<TagValue> getTagValuesImpl(java.util.List<TagPath> paths)
                                             throws java.lang.Exception

Description copied from class: AbstractTagUtilities

Bulk implementation of retrieving tag values. List is guaranteed to be non-null and non-empty.

Specified by:

getTagValuesImpl in class AbstractTagUtilities

Throws:

java.lang.Exception

writeToTagsImpl

protected int[] writeToTagsImpl(java.util.List<TagPath> paths,
                                java.util.List<java.lang.Object> values)
                         throws java.lang.Exception

Description copied from class: AbstractTagUtilities

Bulk implementation of writing to tags. Lists are guaranteed to be non-null and non-empty, and matching in size.

Specified by:

writeToTagsImpl in class AbstractTagUtilities

Returns:

Array of return codes. (0=fail, 1=succeed, 2=pending)

Throws:

java.lang.Exception

configureImpl

protected void configureImpl(java.lang.String path,
                             TagConfigSet cfg,
                             TagManagerBase.CollisionPolicy policy)

Specified by:

configureImpl in class AbstractTagUtilities

browseConfiguration

public TagConfigSet browseConfiguration(java.lang.String path,
                                        boolean recursive)

Specified by:

browseConfiguration in class AbstractTagUtilities