read

[ Funktion ]

Version 1.8

public read(): any;

Version 1.12

public read<T = ST>(): T;

Liest den Wert des Symbols.

Ab Version 1.10 werden Symbol-Abfragen direkt gegen die Komponente ausgeführt, welche die Daten zur Verfügung stellt. Da eine synchrone Abfrage von Symbolen aus dem Server nicht möglich ist, verwenden Sie zum Abfragen von Server-Symbolen bitte die Funktion readEx.

Version 1.12: Wird die API in TypeScript-Code benutzt, so kann beim Erstellen eines Symbols dem TypeScript-Compiler mitgeteilt, welchen Typ das Symbol (ST: SymbolType) hat. Dieser muss dann beispielsweise bei Nutzung dieser Funktion nicht mehr angegeben werden. Dies kann jedoch auch hier überschrieben werden.

Dies ist eine reine Hilfe für die Programmierung. Der Browser kennt diese „Typeannotation“ nicht. Es findet keine Prüfung oder Konvertierung zur Laufzeit statt.

Parameter

Rückgabewert

Verfügbar ab Version 1.8

Beispiel - JavaScript

var sym = new TcHmi.Symbol('%i%myInternalSym%/i%');
var symVal = sym.read();

Beispiel 1 - TypeScript

let sym = new TcHmi.Symbol ('%i%myInternalSym%/i%');
let symVal = sym.read(); // TS does not know the variable type

Beispiel 2 - TypeScript

let sym = new TcHmi.Symbol<boolean>('%i%myInternalSym%/i%');
let thisIsABoolean = sym.read(); // TS knows this is a boolean

Beispiel 3 - TypeScript

let sym = new TcHmi.Symbol('%i%myInternalSym%/i%');
let thisIsABoolean = sym.read<boolean>(); // Define as a Boolean