Symbol Class

A symbol in the Built-in Tag Server symbol table.

Inheritance Hierarchy

Namespace: Demo3D.PLC.Comms.Builtin
Assembly: PLC (in PLC.dll) Version: 19.00.00

Syntax

public class Symbol : BrowseItemBase

The Symbol type exposes the following members.

Constructors

	Name	Description
	Symbol(IBrowseItem, String, AccessRights, DataType)	Constructs a new symbol for the Built-in Tag Server.
	Symbol(IBrowseItem, String, AccessRights, Type)	Constructs a new symbol for the Built-in Tag Server.

Properties

	Name	Description
	AccessName	The address used to access the item from the PLC. (Inherited from StringAddress)
	AllowDeepSearch	When searching for an item by AccessName, defines whether to deep search the symbol table. (Inherited from BrowseItemBase)
	AllowedAccess	The access allowed for this symbol. (Overrides StringAddressAllowedAccess)
	DataType	The data type of the symbol.
	Description	Description / comment for this browse item node. (Inherited from BrowseItemBase)
	DescriptiveName	A descriptive name (shown in the Tag Server Explorer), or null to use Name. (Inherited from BrowseItemBase)
	IsBranch	Returns true if this item has children and can be expanded. (Inherited from BrowseItemBase)
	IsItem	Returns true if this item can be loaded. (Inherited from BrowseItemBase)
	Name	The name of this browse item node. (Inherited from BrowseItemBase)

Methods

	Name	Description
	Equals(IAddress)	Determines whether the address equals the current address. (Inherited from StringAddress)
	Equals(Object)	Determines whether the specified address equals the current address. (Inherited from StringAddress)
	Equals(StringAddress)	Determines whether the address equals the current address. (Inherited from StringAddress)
	FindChild	Find a child by itemName or accessName. (Inherited from BrowseItemBase)
	GetChildren	Return children of a branch item. (Inherited from BrowseItemBase)
	GetDataType	Returns the data type for this symbol. (Overrides StringAddressGetDataType(DataType, Boolean))
	GetHashCode	Computes a hash code for this address. (Inherited from StringAddress)
	ToString	Returns a string that represents the current browse item. (Inherited from BrowseItemBase)

Fields

	Name	Description
	accessName	A cache of the string representation of the address. (Inherited from StringAddress)
	children	Access to the list of child browse items. (Inherited from BrowseItemBase)

Remarks

Your server doesn't have to expose a symbol table at all, so this class is optional. But it's useful if you can, and very helpful for the user.

A symbol in the symbol table must implement IBrowseItem. BrowseItemBase is a generic implementation of IBrowseItem.