Symbol Class

Represents a symbol of a TwinCAT HMI server extension.

Inheritance Hierarchy

SystemObject
  TcHmiSrv.Core.Tools.DynamicSymbolsSymbol
    TcHmiSrv.Core.Tools.DynamicSymbolsAsyncSymbol
    TcHmiSrv.Core.Tools.DynamicSymbolsSymbolWithValue

Namespace: TcHmiSrv.Core.Tools.DynamicSymbols
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

Syntax

C#

public abstract class Symbol : IEquatable<Symbol>

The Symbol type exposes the following members.

Constructors

 

Name

Description

Symbol Class 1:

Symbol(JsonSchemaValue)

Initializes a new instance of the Symbol class with the specified schema.

Symbol Class 2:

Symbol(JsonSchemaValue, NullableBoolean)

Initializes a new instance of the Symbol class with the specified schemes.

Symbol Class 3:

Symbol(JsonSchemaValue, JsonSchemaValue)

Initializes a new instance of the Symbol class with the specified schemes.

Symbol Class 4:

Symbol(JsonSchemaValue, JsonSchemaValue, IDictionaryString, Value)

Initializes a new instance of the Symbol class with the specified schemes.

Symbol Class 5:

Symbol(JsonSchemaValue, JsonSchemaValue, NullableBoolean)

Initializes a new instance of the Symbol class with the specified schemes.

Symbol Class 6:

Symbol(JsonSchemaValue, JsonSchemaValue, NullableBoolean, NullableBoolean)

Initializes a new instance of the Symbol class with the specified schemes.

Symbol Class 7:

Symbol(JsonSchemaValue, JsonSchemaValue, NullableBoolean, String)

Initializes a new instance of the Symbol class with the specified schemes.

Symbol Class 8:

Symbol(JsonSchemaValue, JsonSchemaValue, NullableBoolean, NullableBoolean, String)

Initializes a new instance of the Symbol class with the specified schemes.

Properties

 

Name

Description

Symbol Class 9:

Attributes

Gets the attributes of the Symbol.

Symbol Class 10:

Definitions

Gets the Definitions of the Symbol.

Symbol Class 11:

Doc

Gets the documentation of the Symbol.

Symbol Class 12:

Function

Gets a value that indicates whether the Symbol is a function.

Symbol Class 13:

ReadOnly

Gets a value that indicates whether the Symbol is read-only.

Symbol Class 14:

ReadValue

Gets the read value of the Symbol.

Symbol Class 15:

Schema

Gets the JsonSchemaValue representing the JSON schema of the Symbol.

Symbol Class 16:

WriteValue

Gets the write value of the Symbol.

Methods

 

Name

Description

Symbol Class 17:

Equals(Object)

Determines whether the specified Object is equal to the current Symbol.
(Overrides ObjectEquals(Object))

Symbol Class 18:

Equals(Symbol)

Indicates whether the current Symbol is equal to another Symbol.

Symbol Class 19:

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)

Symbol Class 20:

GetHashCode

Serves as the default hash function.
(Overrides ObjectGetHashCode)

Symbol Class 21:

GetType

Gets the Type of the current instance.
(Inherited from Object)

Symbol Class 22:

MemberwiseClone

Creates a shallow copy of the current Object.
(Inherited from Object)

Symbol Class 23:

Read(QueueString)

Reads the Value at the specified path from the current Symbol.

Symbol Class 24:

Read(QueueString, Context)

Reads the Value at the specified path from the current Symbol.

Symbol Class 25:

ToString

Returns a string that represents the current object.
(Overrides ObjectToString)

Symbol Class 26:

Write(QueueString, Value)

Writes the specified Value at the specified path to the current Symbol.

Symbol Class 27:

Write(QueueString, Value, Context)

Writes the specified Value at the specified path to the current Symbol.

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

TcHmiSrv.Core.Tools.DynamicSymbols Namespace

Copyright © Beckhoff Automation GmbH & Co. KG