Package com.inductiveautomation.ignition.common.script

Class TagChangeScript

java.lang.Object

com.inductiveautomation.ignition.common.script.TagChangeScript

All Implemented Interfaces:

Comparable<TagChangeScript>

public class TagChangeScript
extends Object
implements Comparable<TagChangeScript>

Holds the configuration for a gateway or client scoped tag change script. These are modified by the user in the Designer in the class com.inductiveautomation.ignition.designer.scripteditor.TagChangeEditor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TagChangeScript.Serializer

Constructor Summary

Constructors

Constructor	Description
TagChangeScript()	Deprecated.
TagChangeScript(TagChangeScript copy)
TagChangeScript(String name)
TagChangeScript(String path, String script)	Constructor for copying from an old-style tag change script where it was a path/script pair.
TagChangeScript(String name, List<String> paths, String script)

Method Summary

Modifier and Type	Method	Description
int	compareTo(@NotNull TagChangeScript o)
EnumSet<FilteredTagChangeListener.TagChangeType>	getChangeTypes()
String	getName()
List<String>	getPaths()
String	getPathsFlattened()
String	getScript()
boolean	isEnabled()
void	setChangeTypes(EnumSet<FilteredTagChangeListener.TagChangeType> changeTypes)
void	setEnabled(boolean enabled)
void	setName(String name)
void	setPaths(List<String> paths)
void	setScript(String script)

Methods inherited from class java.lang.Object

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

Constructor Details

TagChangeScript

@Deprecated
public TagChangeScript()

Deprecated.

For serialization.

TagChangeScript

public TagChangeScript(String path,
 String script)

Constructor for copying from an old-style tag change script where it was a path/script pair.

TagChangeScript

public TagChangeScript(String name)

TagChangeScript

public TagChangeScript(String name,
 List<String> paths,
 String script)

TagChangeScript

public TagChangeScript(TagChangeScript copy)

Method Details

getName

public String getName()

setName

public void setName(String name)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getPaths

public List<String> getPaths()

setPaths

public void setPaths(List<String> paths)

getScript

public String getScript()

setScript

public void setScript(String script)

getChangeTypes

public EnumSet<FilteredTagChangeListener.TagChangeType> getChangeTypes()

setChangeTypes

public void setChangeTypes(EnumSet<FilteredTagChangeListener.TagChangeType> changeTypes)

getPathsFlattened

public String getPathsFlattened()

compareTo

public int compareTo(@NotNull
 @NotNull TagChangeScript o)

Specified by:

compareTo in interface Comparable<TagChangeScript>