Package com.inductiveautomation.ignition.common.tags.browsing

Class UdtDefinitionInfo

java.lang.Object

com.inductiveautomation.ignition.common.tags.browsing.UdtDefinitionInfo

All Implemented Interfaces:

Serializable

public class UdtDefinitionInfo
extends Object
implements Serializable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UdtDefinitionInfo(TagPath typePath, NodeDescription rootInfo, Map<TagPath,NodeDescription> members)

Method Summary

Modifier and Type	Method	Description
NodeDescription	getMember(TagPath memberPath)	Looks up the member based on the path.
Map<TagPath,NodeDescription>	getMemberMap()	Tag paths are relative to the type root.
Collection<NodeDescription>	getMembers()
protected TagPath	getRelativeMemberPath(TagPath typePath, TagPath fullMemberPath)	Members contain their full tag path.
NodeDescription	getRootInfo()	Gets the node browse info for the root udt definition;
String	getTypeId()

Methods inherited from class java.lang.Object

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

Constructor Details

UdtDefinitionInfo

public UdtDefinitionInfo(TagPath typePath,
 NodeDescription rootInfo,
 Map<TagPath,NodeDescription> members)

Method Details

getTypeId

public String getTypeId()

getRootInfo

public NodeDescription getRootInfo()

Gets the node browse info for the root udt definition;

getMemberMap

public Map<TagPath,NodeDescription> getMemberMap()

Tag paths are relative to the type root.

getMembers

public Collection<NodeDescription> getMembers()

getMember

public NodeDescription getMember(TagPath memberPath)

Looks up the member based on the path. The path is relative.

getRelativeMemberPath

protected TagPath getRelativeMemberPath(TagPath typePath,
 TagPath fullMemberPath)

Members contain their full tag path. This function will trim off the part that contains the type definition.