Package com.inductiveautomation.ignition.gateway.tags.config

Class TagConfigDefinition

java.lang.Object

com.inductiveautomation.ignition.gateway.tags.config.TagConfigDefinition

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

UdtConfigDefinition

public class TagConfigDefinition
extends Object
implements Serializable

The basic definition of any tag type. This defines a single folder, UDT member, or tag override. These are what are converted into running objects by the tag evaluation manager.

Since:

8.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TagConfigDefinition(NodeId id)
TagConfigDefinition(NodeId id, BoundPropertySet config)
TagConfigDefinition(NodeId id, NodeId folder, BoundPropertySet config, int rank)

Method Summary

Modifier and Type	Method	Description
BoundPropertySet	getConfig()
NodeId	getFolder()
NodeId	getId()
int	getIndex()
int	getRank()	Rank helps to ensure that we load tags in an optimal order.
TagObjectType	getType()	The tag object type is the most fundamental indicator of what type of tag node this represents.
void	setConfig(BoundPropertySet config)
void	setFolder(NodeId folder)
void	setId(NodeId id)
void	setIndex(int index)	Sets the list order of this node within a list.
void	setRank(int rank)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TagConfigDefinition

public TagConfigDefinition(NodeId id)

TagConfigDefinition

public TagConfigDefinition(NodeId id,
 NodeId folder,
 BoundPropertySet config,
 int rank)

TagConfigDefinition

public TagConfigDefinition(NodeId id,
 BoundPropertySet config)

Method Details

getId

public NodeId getId()

setId

public void setId(NodeId id)

getRank

public int getRank()

Rank helps to ensure that we load tags in an optimal order. It is a number that indicates inheritance hierarchy and folder depth. See the NodeRank class for more information.

setRank

public void setRank(int rank)

getType

@Nullable
public TagObjectType getType()

The tag object type is the most fundamental indicator of what type of tag node this represents.

getConfig

public BoundPropertySet getConfig()

setConfig

public void setConfig(BoundPropertySet config)

getFolder

public NodeId getFolder()

setFolder

public void setFolder(NodeId folder)

setIndex

public void setIndex(int index)

Sets the list order of this node within a list. This allows the list order to be re-established when a list of TagConfigDefinitions is de-serialized on a different machine.

getIndex

public int getIndex()

toString

public String toString()

Overrides:

toString in class Object