Package com.inductiveautomation.ignition.common.tags.model

Interface TagManager

    • Field Detail

      • DATA_SOURCE_OPC

        static final java.lang.String DATA_SOURCE_OPC
        Type id for OPC data from browseTagDataSource
        See Also:
        Constant Field Values

      • BROWSE_LOCAL_SYSTEM

        static final java.lang.String BROWSE_LOCAL_SYSTEM
        Browse can go through a tag provider, but we may also want to just browse the local gateway- for non tag provider related purposes. Instead of having two browse apis, we can reuse this one with a special provider name.
        See Also:
        Constant Field Values

    • Method Detail

      • getTagGroupConfigModelAsync

        java.util.concurrent.CompletableFuture<ConfigurationPropertyModel> getTagGroupConfigModelAsync​(java.lang.String provider)

      • getTagConfigModelAsync

        java.util.concurrent.CompletableFuture<ConfigurationPropertyModel> getTagConfigModelAsync​(java.lang.String provider)

      • getTagGroupsAsync

        java.util.concurrent.CompletableFuture<java.util.List<TagGroupConfiguration>> getTagGroupsAsync​(java.lang.String provider)

      • moveTagsAsync

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> moveTagsAsync​(java.util.List<TagPath> tags,
                                                                                  TagPath destination,
                                                                                  boolean copy,
                                                                                  CollisionPolicy collisionPolicy,
                                                                                  SecurityContext securityContext)
        Copies tags from any sources to a specific destination. Destination may be in a different provider. If the source and destination paths are all in the same provider, and copy is FALSE, it will be treated as a move.

      • moveTagsAsync

        default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> moveTagsAsync​(java.util.List<TagPath> tags,
                                                                                          TagPath destination,
                                                                                          boolean copy,
                                                                                          CollisionPolicy collisionPolicy)

      • readAsync

        default java.util.concurrent.CompletableFuture<java.util.List<QualifiedValue>> readAsync​(java.util.List<TagPath> tagPaths)

      • writeAsync

        default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> writeAsync​(java.util.List<TagPath> tagPaths,
                                                                                       java.util.List<java.lang.Object> values)

      • writeAsync

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> writeAsync​(java.util.List<TagPath> tagPaths,
                                                                               java.util.List<java.lang.Object> values,
                                                                               SecurityContext securityContext)

      • reinitializeTags

        default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> reinitializeTags​(java.util.List<TagPath> tagPaths)

      • subscribeAsync

        default java.util.concurrent.CompletableFuture<java.lang.Void> subscribeAsync​(TagPath tagPath,
                                                                              TagChangeListener listener)

      • subscribeAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> subscribeAsync​(java.util.List<TagPath> tagPaths,
                                                                      java.util.List<TagChangeListener> listeners)

      • unsubscribeAsync

        default java.util.concurrent.CompletableFuture<java.lang.Void> unsubscribeAsync​(TagPath tagPath,
                                                                                TagChangeListener listener)

      • unsubscribeAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> unsubscribeAsync​(java.util.List<TagPath> tagPaths,
                                                                        java.util.List<TagChangeListener> listeners)

      • getDiagnosticsAsync

        java.util.concurrent.CompletableFuture<TagDiagnostics> getDiagnosticsAsync​(TagPath path)

      • importTagsAsync

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> importTagsAsync​(TagPath basePath,
                                                                                    java.lang.String importText,
                                                                                    java.lang.String importType,
                                                                                    CollisionPolicy collisionPolicy)
        Parameters:
        basePath - tags will be imported using this location as the base. The provider source must be set.
        importText - a String holding the contents of the file to import
        importType - The import file type. Use "json", "xml" or "csv". Any other value will return an error.
        collisionPolicy - The collision policy to use. Abort will throw an exception on the first tag collision, Ignore will not change the existing tag at all, Overwrite will overwrite the existing tag completely, and Rename will create a new tag with a similar name (MyTag becomes MyTag1).