Package com.inductiveautomation.ignition.client.tags.impl

Class GatewayTagInterface

java.lang.Object

com.inductiveautomation.ignition.client.tags.impl.GatewayTagInterface

public class GatewayTagInterface
extends Object

This class is the link between tags in the client and tags in the gateway.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	GatewayTagInterface.ErrorClientTagProvider	This ClientTagProvider is used when the default tag provider is not set on the project.
protected class	GatewayTagInterface.GatewayProviderProxy

Constructor Summary

Constructors

Constructor	Description
GatewayTagInterface(ClientContext context, TagProviderRpc tagProviderRpc)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Results<Result>>	browseHistoricalTagsAsync(QualifiedPath root, BrowseFilter filter)
CompletableFuture<Results<BrowseElement>>	browseTagDataSourcesAsync(String provider, BrowseElement root, BrowseFilter filter)
protected TagPath	clean(TagPath path)
protected ArrayList<TagPath>	clean(List<TagPath> paths)
void	copyTagsToClipboard(List<TagPath> tagPaths, boolean removeOriginalTags)
CompletableFuture<Results<NodeDescription>>	creatorBrowse(String provider, String sessionKey, TagPath tagPath, boolean single)
CompletableFuture<PropertySet>	creatorModify(String provider, String session, PropertySet changes)
ClientTagProvider	get(String providerName)
CompletableFuture<List<QualityCode>>	moveTagsAsync(List<TagPath> tags, TagPath destination, boolean copy, CollisionPolicy collisionPolicy)
CompletableFuture<List<QualityCode>>	pasteFromClipboard(TagPath destination)
CompletableFuture<QualityCode>	renameTagAsync(TagPath tag, String newName, CollisionPolicy collisionPolicy)
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Details

GatewayTagInterface

public GatewayTagInterface(ClientContext context,
 TagProviderRpc tagProviderRpc)

Method Details

shutdown

public void shutdown()

clean

protected TagPath clean(TagPath path)

clean

protected ArrayList<TagPath> clean(List<TagPath> paths)

get

public ClientTagProvider get(String providerName)

browseHistoricalTagsAsync

public CompletableFuture<Results<Result>> browseHistoricalTagsAsync(QualifiedPath root,
 BrowseFilter filter)

browseTagDataSourcesAsync

public CompletableFuture<Results<BrowseElement>> browseTagDataSourcesAsync(String provider,
 BrowseElement root,
 BrowseFilter filter)

copyTagsToClipboard

public void copyTagsToClipboard(List<TagPath> tagPaths,
 boolean removeOriginalTags)

pasteFromClipboard

public CompletableFuture<List<QualityCode>> pasteFromClipboard(TagPath destination)

creatorBrowse

public CompletableFuture<Results<NodeDescription>> creatorBrowse(String provider,
 String sessionKey,
 TagPath tagPath,
 boolean single)

creatorModify

public CompletableFuture<PropertySet> creatorModify(String provider,
 String session,
 PropertySet changes)

moveTagsAsync

public CompletableFuture<List<QualityCode>> moveTagsAsync(List<TagPath> tags,
 TagPath destination,
 boolean copy,
 CollisionPolicy collisionPolicy)

renameTagAsync

public CompletableFuture<QualityCode> renameTagAsync(TagPath tag,
 String newName,
 CollisionPolicy collisionPolicy)