Symbol

[ Class ]

Access to symbol information.

Constructors

Name

Description

constructor

Creates an instance of the symbol.

Functions

Name

Description

read

Reads the value of the symbol.

readEx

Reads the value of the symbol.

write

Writes the value of the symbol.

watch

Monitors the symbol for changes.

resolveAttributes

Returns a list of attributes from the schema of the corresponding symbol.

This function can be used to obtain a list of attributes of a PLC symbol.

resolveAttribute

Returns a specific attribute from the schema of the corresponding symbol.

This function can be used to obtain a specific attribute of a PLC symbol.

exists

Checks if the symbol exists.

resolveSchema

Resolves the schema of the symbol and returns it using the callback function.

getExpression

Returns the TcHmi.SymbolExpression object associated with the symbol.

destroy

Destroys the Object symbol.

Static functions

Name

Description

read

Reads the value of a symbol addressed by its name and symbol type.

readEx

Reads the value of a symbol addressed via the symbol expression.

readEx2

Reads the value of a symbol addressed via the symbol expression.

write

Writes the value of a symbol addressed by its name and symbol type.

writeEx

Writes the value of a symbol addressed via the symbol expression.

resolveAttributes

Returns a list of attributes from the schema of the corresponding symbol.

This function can be used to obtain a list of attributes of a PLC symbol.

resolveAttribute

Returns a specific attribute from the schema of the corresponding symbol.

This function can be used to obtain a specific attribute of a PLC symbol.

exists

Checks if the symbol exists.

resolveSchema

Resolves the schema of the symbol and returns it using the callback function.

isSymbolExpression

Checks whether an expression is a valid symbol expression.

Interfaces

Name

Description

IReadResultObject

Extends TcHmi.IResultObject

IServerReadResultObject

Extends IReadResultObject

IWriteResultObject

Extends TcHmi.IResultObject

IServerWriteResultObject

Extends IWriteResultObject

IWatchResultObject

Extends TcHmi.IResultObject

IServerWatchResultObject

Extends IWatchResultObject

ISchemaResultObject

Extends TcHmi.IResultObject

IExistsResultObject

Extends TcHmi.IResultObject

IAttributesResultObject

Extends TcHmi.IResultObject

IAttributeResultObject

Extends TcHmi.IResultObject

Symbol 1:

Available from 1.8