Package 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

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

DEFAULT_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor	Description
ClientTagUtilities(ClientContext context, ClientTagManager tagManager)

Method Summary

Modifier and Type	Method	Description
protected Results	browseHistoricalTagsImpl(QualifiedPath path, BrowseFilter filter)
protected Results<PyTagDictionary>	browseImpl(TagPath path, BrowseFilter browseFilter)
protected boolean	canEditForProvider(String provider)
protected boolean	checkWriteMode(List<TagPath> tagPaths)
protected boolean	containsClientTags(List<TagPath> tagPaths)
protected String	exportInternal(String filePath, List<TagPath> tagPaths, boolean recursive, String exportType)	For the exportType, use "json" or "xml"
protected List<TagConfigurationModel>	getConfigurationImpl(List<TagPath> basePaths, boolean recursive)
protected CompletableFuture<List<QualifiedValue>>	getQualifiedValues(List<TagPath> tagPaths)
protected TagConfigurationModel	getTagConfigurationModel(TagPath path)
protected List<QualityCode>	importInternal(TagPath basePath, String fileAsStr, String importType, CollisionPolicy cp)
protected List<QualityCode>	moveImpl(List<TagPath> source, TagPath dest, boolean copy, CollisionPolicy policy)
protected List<Annotation>	queryAnnotationsImpl(List<Path> paths, Date start, Date end, TypeFilter filter)
protected Results<PyTagDictionary>	queryImpl(String provider, TagQueryFilter queryFilter)
protected Dataset	queryTagCalculationsImpl(List<QualifiedPath> paths, List<Aggregate> colAggModes, Date startDate, Date endDate, List<String> aliases, Flags queryFlags)
protected Dataset	queryTagDensityImpl(List<QualifiedPath> paths, Date startDate, Date endDate)
protected Dataset	queryTagHistoryImpl(List<QualifiedPath> paths, Date startDate, Date endDate, int returnSize, Aggregate aggregationMode, ReturnFormat format, List<String> aliases, List<Aggregate> columnAggModes, Flags queryFlags, int timeout)
protected void	readAsyncImpl(List<TagPath> tagPaths, org.python.core.PyObject callback)
protected List<QualifiedValue>	readBlockingImpl(List<TagPath> tagPaths, int timeoutMillis)
protected List<QualityCode>	removeTagsImpl(List<TagPath> tagPaths)
protected QualityCode	renameImpl(TagPath tagPath, String newName, CollisionPolicy collisionPolicy)
protected void	requestGroupExecutionImpl(String provider, String tagGroup)
protected List<QualityCode>	saveTagConfigs(String provider, List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy)	Processes tag edits.
protected List<QualifiedValue>	storeAnnotationsImpl(List<Annotation> annotations)
protected void	storeTagHistoryImpl(org.python.core.PyObject[] pyArgs, String[] keywords)
protected QualifiedPath	toQualifiedPathFromHistoricalString(String path)
protected void	writeAsyncImpl(List<TagPath> tagPaths, List<Object> values, org.python.core.PyObject callback)
protected List<QualityCode>	writeBlockingImpl(List<TagPath> tagPaths, List<Object> values, int timeoutMillis)

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

browse, browseHistoricalTags, configure, copy, deleteAnnotations, deleteTags, exists, exportTags, getAggregateFor, getConfiguration, importTags, interpretRange, move, nodeDescriptionToDictionary, parseTagPath, parseTagPaths, query, queryAnnotations, queryTagCalculations, queryTagDensity, queryTagHistory, readAsync, readBlocking, rename, requestGroupExecution, storeAnnotations, storeTagHistory, writeAsync, writeBlocking

Methods inherited from class java.lang.Object

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

Constructor Details

ClientTagUtilities

public ClientTagUtilities(ClientContext context,
 ClientTagManager tagManager)

Method Details

moveImpl

protected List<QualityCode> moveImpl(List<TagPath> source,
 TagPath dest,
 boolean copy,
 CollisionPolicy policy)

Specified by:

moveImpl in class AbstractTagUtilities

getConfigurationImpl

protected List<TagConfigurationModel> getConfigurationImpl(List<TagPath> basePaths,
 boolean recursive)

Specified by:

getConfigurationImpl in class AbstractTagUtilities

saveTagConfigs

protected List<QualityCode> saveTagConfigs(String provider,
 List<TagConfiguration> tagEdits,
 CollisionPolicy collisionPolicy)

Description copied from class: AbstractTagUtilities

Processes tag edits. The edit can represent a modification of a config, a new tag, or a deletion.

Specified by:

saveTagConfigs in class AbstractTagUtilities

importInternal

protected List<QualityCode> importInternal(TagPath basePath,
 String fileAsStr,
 String importType,
 CollisionPolicy cp)
                                    throws Exception

Specified by:

importInternal in class AbstractTagUtilities

Throws:

Exception

browseImpl

protected Results<PyTagDictionary> browseImpl(TagPath path,
 BrowseFilter browseFilter)

Specified by:

browseImpl in class AbstractTagUtilities

queryImpl

protected Results<PyTagDictionary> queryImpl(String provider,
 TagQueryFilter queryFilter)

Specified by:

queryImpl in class AbstractTagUtilities

readAsyncImpl

protected void readAsyncImpl(List<TagPath> tagPaths,
 org.python.core.PyObject callback)

Specified by:

readAsyncImpl in class AbstractTagUtilities

readBlockingImpl

protected List<QualifiedValue> readBlockingImpl(List<TagPath> tagPaths,
 int timeoutMillis)

Specified by:

readBlockingImpl in class AbstractTagUtilities

writeBlockingImpl

protected List<QualityCode> writeBlockingImpl(List<TagPath> tagPaths,
 List<Object> values,
 int timeoutMillis)

Specified by:

writeBlockingImpl in class AbstractTagUtilities

writeAsyncImpl

protected void writeAsyncImpl(List<TagPath> tagPaths,
 List<Object> values,
 org.python.core.PyObject callback)

Specified by:

writeAsyncImpl in class AbstractTagUtilities

checkWriteMode

protected boolean checkWriteMode(List<TagPath> tagPaths)

Returns:

true if write attempt contains client tags, or the designer is in write mode, or if user allows a one-time write via dialog.

containsClientTags

protected boolean containsClientTags(List<TagPath> tagPaths)

exportInternal

protected String exportInternal(String filePath,
 List<TagPath> tagPaths,
 boolean recursive,
 String exportType)
                         throws Exception

Description copied from class: AbstractTagUtilities

For the exportType, use "json" or "xml"

Specified by:

exportInternal in class AbstractTagUtilities

Throws:

Exception

removeTagsImpl

protected List<QualityCode> removeTagsImpl(List<TagPath> tagPaths)
                                    throws Exception

Specified by:

removeTagsImpl in class AbstractTagUtilities

Throws:

Exception

requestGroupExecutionImpl

protected void requestGroupExecutionImpl(String provider,
 String tagGroup)
                                  throws Exception

Specified by:

requestGroupExecutionImpl in class AbstractTagUtilities

Throws:

Exception

storeTagHistoryImpl

protected void storeTagHistoryImpl(org.python.core.PyObject[] pyArgs,
 String[] keywords)
                            throws Exception

Specified by:

storeTagHistoryImpl in class AbstractTagUtilities

Throws:

Exception

queryTagHistoryImpl

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

Specified by:

queryTagHistoryImpl in class AbstractTagUtilities

Throws:

Exception

queryTagCalculationsImpl

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

Specified by:

queryTagCalculationsImpl in class AbstractTagUtilities

Throws:

Exception

queryTagDensityImpl

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

Specified by:

queryTagDensityImpl in class AbstractTagUtilities

Throws:

Exception

toQualifiedPathFromHistoricalString

protected QualifiedPath toQualifiedPathFromHistoricalString(String path)

Overrides:

toQualifiedPathFromHistoricalString in class AbstractTagUtilities

browseHistoricalTagsImpl

protected Results browseHistoricalTagsImpl(QualifiedPath path,
 BrowseFilter filter)

Specified by:

browseHistoricalTagsImpl in class AbstractTagUtilities

canEditForProvider

protected boolean canEditForProvider(String provider)

Specified by:

canEditForProvider in class AbstractTagUtilities

storeAnnotationsImpl

protected List<QualifiedValue> storeAnnotationsImpl(List<Annotation> annotations)

Specified by:

storeAnnotationsImpl in class AbstractTagUtilities

queryAnnotationsImpl

protected List<Annotation> queryAnnotationsImpl(List<Path> paths,
 Date start,
 Date end,
 TypeFilter filter)

Specified by:

queryAnnotationsImpl in class AbstractTagUtilities

getTagConfigurationModel

protected TagConfigurationModel getTagConfigurationModel(TagPath path)
                                                  throws Exception

Specified by:

getTagConfigurationModel in class AbstractTagUtilities

Throws:

Exception

getQualifiedValues

protected CompletableFuture<List<QualifiedValue>> getQualifiedValues(List<TagPath> tagPaths)

Specified by:

getQualifiedValues in class AbstractTagUtilities

renameImpl

protected QualityCode renameImpl(TagPath tagPath,
 String newName,
 CollisionPolicy collisionPolicy)
                          throws Exception

Specified by:

renameImpl in class AbstractTagUtilities

Throws:

Exception