Funktionen

Die HMI Process Library enthält eine Reihe von Funktionen. Die folgende Tabelle zeigt weitere allgemeine Funktionen aus der HMI Process Library:

Name

Kategorie

Beschreibung

AnalogCompressionValueFormatter

Formatting

Gibt für den übergebenen Wert eine Zeichenkette im komprimierten Format zurück (nicht länger als die angegebene Anzahl an Zeichen, Vorzeichen und Dezimaltrennzeichen ausgenommen).

Typ des Rückgabewerts: String.

Argumente:

  • value: Der Wert, der im komprimierten Format dargestellt wird. Von -1015 bis +1015 (ohne Grenzwerte). Der betragsmäßig kleinste Wert kann 10-15 betragen.
  • Typ: String.
  • maxCharacters: Maximale Anzahl von Zeichen, die der Wert haben sollte (ohne Vorzeichen und Dezimaltrennzeichen; kann nicht kleiner als 4 sein).
  • Typ: Nummer.
  • showPlus: Wenn true, wird das Pluszeichen für positive Werte angezeigt.
  • Typ: Boolean.
  • fallbackValue: Das zurückgegebene Ergebnis, wenn der Wert undefiniert oder null ist. Der Default-Fallbackwert ist 'NaN'.
  • Typ: String.

AnalogValueFormatter

Formatting

Gibt eine formatierte Zeichenkette für den übergebenen Wert zurück.

Typ des Rückgabewerts: String.

Argumente:

  • value: Der zu formatierende Wert.
  • Typ: String.
  • maxDecimals: Wie viele Dezimalstellen der Wert haben soll.
  • Typ: Nummer.
  • showPlus: Wenn true, wird das Pluszeichen für positive Werte angezeigt.
  • Typ: Boolean.
  • fallbackValue: Das zurückgegebene Ergebnis, wenn der Wert undefiniert oder null ist. Der Default-Fallbackwert ist 'NaN'.
  • Typ: String.

BinaryValueFormatter

Formatting

Gibt eine formatierte Zeichenkette für den übergebenen Wert zurück.

Typ des Rückgabewerts: String.

Argumente:

  • value: Der zu formatierende Wert.
  • Typ: String.
  • trueValue: Ersatzzeichenkette für den true-Wert.
  • Typ: String.
  • falseValue: Ersatzzeichenkette für den false-Wert.
  • Typ: String.
  • fallbackValue: Das zurückgegebene Ergebnis, wenn der Wert nicht TRUE oder FALSE ist. Der Default-Fallbackwert ist eine leere Zeichenkette.
  • Typ: String.

TernaryValueFormatter

Formatting

Gibt eine formatierte Zeichenkette für den übergebenen Wert zurück. [bVal1.toString() + bVal2.toString()].

Typ des Rückgabewerts: String.

Argumente:

  • value: Der zu formatierende Wert [bVal1.toString() + bVal2.toString()], gültige Werte
    • 'truefalse'
    • 'falsetrue'
    • 'falsefalse'
  • Typ: String.
  • truefalseValue: Ersatzzeichenkette für den Wert 'truefalse'.
  • Typ: String.
  • falsetrueValue: Ersatzzeichenkette für den Wert 'falsetrue'.
  • Typ: String.
  • falsefalseValue: Ersatzzeichenkette für den Wert 'falsefalse'.
  • Typ: String.
  • fallbackValue: Das zurückgegebene Ergebnis, wenn der Wert nicht im Bereich der möglichen Werte liegt. Der Default-Fallbackwert ist eine leere Zeichenkette.
  • Typ: String.

MapValueFormatter

Formatting

Gibt einen Wert zurück, der dem übergebenen Key entspricht.

Typ des Rückgabewerts: String.

Argumente:

  • key: Der zu ersetzende Wert
  • Typ: Beliebig.
  • mapObj: Zuordnung für Ersetzungen key -> value. Zum Beispiel: {"key1": "value1", "key2": "value2"}
  • Typ: Objekt.
  • fallbackValue: Das zurückgegebene Ergebnis, wenn der Key nicht unter den Keys des mapObje ist. Der Default-Fallbackwert ist eine leere Zeichenkette.
  • Typ: String.

Die folgende Tabelle zeigt die zusätzlichen MTP-spezifischen Funktionen aus der HMI Process Library:

Name

Kategorie

Beschreibung

MTPIsCommandEnabled

Checking

Gibt true zurück, wenn der Befehl aktiviert ist.

Typ des Rückgabewerts: Boolean.

Argumente:

  • CommandEN: CommandEN-Variable des Service.
  • Typ: Nummer.
  • Befehl: Zu prüfender Befehl.
  • Typ: String.

MTPStateValueFormatter

Formatting

Rückgabe einer formatierten Statuszeichenkette für den übergebenen Wert.

Typ des Rückgabewerts: String.

Argumente:

  • value: Der zu formatierende Wert.
  • Typ: String.

MTPUnitValueFormatter

Formatting

Gibt eine formatierte Einheiten-Zeichenkette für den übergebenen Wert zurück.

Typ des Rückgabewerts: String.

Argumente:

  • value: Der zu formatierende Einheiten-Wert.
  • Typ: String.
  • customUnits: Wörterbuch für Ersetzungen num -> unit. num sollte eine positive ganze Zahl sein, die in Anführungszeichen steht. Der Defaultwert ist {"1": "Benutzerdefinierte Einheit 1", "2": "Benutzerdefinierte Einheit 2"}
  • Typ: Objekt.
  • fallbackValue: Das zurückgegebene Ergebnis, wenn der Wert undefiniert oder null ist. Der Default-Fallbackwert ist eine leere Zeichenkette.
  • Typ: String.