Click or drag to resize

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: 15.0.2.11458
Syntax
C#
public class Symbol : BrowseItemBase

The Symbol type exposes the following members.

Constructors
  NameDescription
Public methodSymbol
Constructs a new symbol for the Built-in Tag Server.
Top
Properties
  NameDescription
Public propertyAccessName
The address used to access the item from the PLC.
(Inherited from StringAddress.)
Protected propertyAllowDeepSearch
When searching for an item by AccessName, defines whether to deep search the symbol table.
(Inherited from BrowseItemBase.)
Public propertyAllowedAccess
The access allowed for this symbol.
(Overrides StringAddressAllowedAccess.)
Public propertyDataType
The data type of the symbol.
Public propertyDescription
Description / comment for this browse item node.
(Inherited from BrowseItemBase.)
Public propertyDescriptiveName
A descriptive name (shown in the Tag Server Explorer), or null to use Name.
(Inherited from BrowseItemBase.)
Public propertyIsBranch
Returns true if this item has children and can be expanded.
(Inherited from BrowseItemBase.)
Public propertyIsItem
Returns true if this item can be loaded.
(Inherited from BrowseItemBase.)
Public propertyName
The name of this browse item node.
(Inherited from BrowseItemBase.)
Public propertyParent
The parent of this browse item.
(Inherited from BrowseItemBase.)
Top
Methods
  NameDescription
Public methodEquals(IAddress)
Determines whether the address equals the current address.
(Inherited from StringAddress.)
Public methodEquals(Object)
Determines whether the specified address equals the current address.
(Inherited from StringAddress.)
Public methodEquals(StringAddress)
Determines whether the address equals the current address.
(Inherited from StringAddress.)
Public methodFindChild
Defaults to FindChildByAccessName.
(Inherited from BrowseItemBase.)
Public methodGetChildren
Return children of a branch item.
(Inherited from BrowseItemBase.)
Public methodGetDataType
Returns the data type for this symbol.
(Overrides StringAddressGetDataType(DataType, Boolean).)
Public methodGetHashCode
Computes a hash code for this address.
(Inherited from StringAddress.)
Public methodToString
Returns a string that represents the current browse item.
(Inherited from BrowseItemBase.)
Top
Fields
  NameDescription
Protected fieldaccessName
A cache of the string representation of the address.
(Inherited from StringAddress.)
Protected fieldchildren
Access to the list of child browse items.
(Inherited from BrowseItemBase.)
Top
Remarks

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

See Also