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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Results
browseHistoricalTagsImpl(QualifiedPath path, BrowseFilter filter)
protected Results<PyTagDictionary>
browseImpl(TagPath path, BrowseFilter browseFilter)
protected boolean
canEditForProvider(java.lang.String provider)
protected boolean
checkWriteMode()
protected void
exportInternal(java.lang.String filePath, java.util.List<TagPath> tagPaths, boolean recursive, java.lang.String exportType)
For the exportType, use "json" or "xml"protected java.util.List<TagConfigurationModel>
getConfigurationImpl(java.util.List<TagPath> basePaths, boolean recursive)
protected java.util.concurrent.CompletableFuture<java.util.List<QualifiedValue>>
getQualifiedValues(java.util.List<TagPath> tagPaths)
protected TagConfigurationModel
getTagConfigurationModel(TagPath path)
protected java.util.List<QualityCode>
importInternal(TagPath basePath, java.lang.String fileAsStr, java.lang.String importType, CollisionPolicy cp)
protected java.util.List<QualityCode>
moveImpl(java.util.List<TagPath> source, TagPath dest, boolean copy, CollisionPolicy policy)
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
readAsyncImpl(java.util.List<TagPath> tagPaths, org.python.core.PyFunction callback)
protected java.util.List<QualifiedValue>
readBlockingImpl(java.util.List<TagPath> tagPaths, int timeoutMillis)
protected java.util.List<QualityCode>
removeTagsImpl(java.util.List<TagPath> tagPaths)
protected QualityCode
renameImpl(TagPath tagPath, java.lang.String newName, CollisionPolicy collisionPolicy)
protected void
requestGroupExecutionImpl(java.lang.String provider, java.lang.String tagGroup)
protected java.util.List<QualityCode>
saveTagConfigs(java.lang.String provider, java.util.List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy)
Processes tag edits.protected QualifiedPath
toQualifiedPathFromHistoricalString(java.lang.String path)
protected void
writeAsyncImpl(java.util.List<TagPath> tagPaths, java.util.List<java.lang.Object> values, org.python.core.PyFunction callback)
protected java.util.List<QualityCode>
writeBlockingImpl(java.util.List<TagPath> tagPaths, java.util.List<java.lang.Object> values, int timeoutMillis)
-
Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractTagUtilities
browse, browseHistoricalTags, configure, copy, deleteTags, exists, exportTags, getAggregateFor, getConfiguration, importTags, interpretRange, move, parseTagPath, parseTagPaths, queryTagCalculations, queryTagDensity, queryTagHistory, readAsync, readBlocking, rename, requestGroupExecution, writeAsync, writeBlocking
-
-
-
-
Constructor Detail
-
ClientTagUtilities
public ClientTagUtilities(ClientContext context, ClientTagManager tagManager)
-
-
Method Detail
-
moveImpl
protected java.util.List<QualityCode> moveImpl(java.util.List<TagPath> source, TagPath dest, boolean copy, CollisionPolicy policy)
- Specified by:
moveImpl
in classAbstractTagUtilities
-
getConfigurationImpl
protected java.util.List<TagConfigurationModel> getConfigurationImpl(java.util.List<TagPath> basePaths, boolean recursive)
- Specified by:
getConfigurationImpl
in classAbstractTagUtilities
-
saveTagConfigs
protected java.util.List<QualityCode> saveTagConfigs(java.lang.String provider, java.util.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 classAbstractTagUtilities
-
importInternal
protected java.util.List<QualityCode> importInternal(TagPath basePath, java.lang.String fileAsStr, java.lang.String importType, CollisionPolicy cp) throws java.lang.Exception
- Specified by:
importInternal
in classAbstractTagUtilities
- Throws:
java.lang.Exception
-
browseImpl
protected Results<PyTagDictionary> browseImpl(TagPath path, BrowseFilter browseFilter)
- Specified by:
browseImpl
in classAbstractTagUtilities
-
readAsyncImpl
protected void readAsyncImpl(java.util.List<TagPath> tagPaths, org.python.core.PyFunction callback)
- Specified by:
readAsyncImpl
in classAbstractTagUtilities
-
readBlockingImpl
protected java.util.List<QualifiedValue> readBlockingImpl(java.util.List<TagPath> tagPaths, int timeoutMillis)
- Specified by:
readBlockingImpl
in classAbstractTagUtilities
-
writeBlockingImpl
protected java.util.List<QualityCode> writeBlockingImpl(java.util.List<TagPath> tagPaths, java.util.List<java.lang.Object> values, int timeoutMillis)
- Specified by:
writeBlockingImpl
in classAbstractTagUtilities
-
writeAsyncImpl
protected void writeAsyncImpl(java.util.List<TagPath> tagPaths, java.util.List<java.lang.Object> values, org.python.core.PyFunction callback)
- Specified by:
writeAsyncImpl
in classAbstractTagUtilities
-
checkWriteMode
protected boolean checkWriteMode()
- Returns:
- true if this is a client (which always allows write mode), or the designer is in write mode or if user allows a one-time write via dialog.
-
exportInternal
protected void exportInternal(java.lang.String filePath, java.util.List<TagPath> tagPaths, boolean recursive, java.lang.String exportType) throws java.lang.Exception
Description copied from class:AbstractTagUtilities
For the exportType, use "json" or "xml"- Specified by:
exportInternal
in classAbstractTagUtilities
- Throws:
java.lang.Exception
-
removeTagsImpl
protected java.util.List<QualityCode> removeTagsImpl(java.util.List<TagPath> tagPaths) throws java.lang.Exception
- Specified by:
removeTagsImpl
in classAbstractTagUtilities
- Throws:
java.lang.Exception
-
requestGroupExecutionImpl
protected void requestGroupExecutionImpl(java.lang.String provider, java.lang.String tagGroup) throws java.lang.Exception
- Specified by:
requestGroupExecutionImpl
in classAbstractTagUtilities
- Throws:
java.lang.Exception
-
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 classAbstractTagUtilities
- 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 classAbstractTagUtilities
- 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 classAbstractTagUtilities
- Throws:
java.lang.Exception
-
toQualifiedPathFromHistoricalString
protected QualifiedPath toQualifiedPathFromHistoricalString(java.lang.String path)
- Overrides:
toQualifiedPathFromHistoricalString
in classAbstractTagUtilities
-
browseHistoricalTagsImpl
protected Results browseHistoricalTagsImpl(QualifiedPath path, BrowseFilter filter)
- Specified by:
browseHistoricalTagsImpl
in classAbstractTagUtilities
-
canEditForProvider
protected boolean canEditForProvider(java.lang.String provider)
- Specified by:
canEditForProvider
in classAbstractTagUtilities
-
getTagConfigurationModel
protected TagConfigurationModel getTagConfigurationModel(TagPath path) throws java.lang.Exception
- Specified by:
getTagConfigurationModel
in classAbstractTagUtilities
- Throws:
java.lang.Exception
-
getQualifiedValues
protected java.util.concurrent.CompletableFuture<java.util.List<QualifiedValue>> getQualifiedValues(java.util.List<TagPath> tagPaths)
- Specified by:
getQualifiedValues
in classAbstractTagUtilities
-
renameImpl
protected QualityCode renameImpl(TagPath tagPath, java.lang.String newName, CollisionPolicy collisionPolicy) throws java.lang.Exception
- Specified by:
renameImpl
in classAbstractTagUtilities
- Throws:
java.lang.Exception
-
-