Objekt-Beschreibungstexte

Platzhalter

Platzhalter stellen einen später generierten Wert dar. Beispielsweise werden die Parameter ObjectName und Description wie folgt mit Standardplatzhaltern initialisiert:

• sObjectName : T_MaxString := '{}';
• sDescription : T_MaxString := '{}';

Bei der Objektinitialisierung analysiert der Textgenerierungsmechanismus einen Text auf definierte Platzhalter.

Nur wenn ein gültiger Platzhalter ermittelt wird, kann der Mechanismus ihn durch einen automatisch generierten Text ersetzen. Andererseits hätte ein manuell definierter Text einen Platzhalter ersetzt und würde nicht überschrieben.

Sobald die Texte generiert sind, enthalten Variablen keine Platzhalter mehr.

Auch wenn das Gerät neu gestartet wird und Parameter (persistente Variablen) gespeichert wurden, bleiben die aktuellen Texte bestehen (automatisch generiert, manuell definiert oder sogar zur Laufzeit von einem Bediener geändert) und werden nicht vom Textgenerierungsmechanismus überschrieben.

Einsatzzweck

• Stellvertretend
  Ein Platzhalter (Hier ein Index) wird stellvertretend für einen Wert eingesetzt:
  sDescription := '{Idx}'
• Definierend
  Ein Platzhalter (Hier ein Index) wird eingesetzt um einen bestimmten Wert zu definieren:
  sDescription := '{Idx=10}'

Indizierung

• Automatische Indizierung
  Für Objekte der letzten beiden Ebenen der Projektstruktur ist eine automatische Indizierung in der Projektvorlage eingestellt. D.h. dass der Parameter ObjectName zusätzlich zu einem definierten Namen auch eine fortlaufende Index Nummer erhält. Indices (z.B. für Aggregate) werden automatisch hinter den Text angehangen.
  Während Indices für den Parameter ObjectName im Normalfall immer erzeugt werden, erscheinen Description-Indices in Abhängigkeit der aktuellen Einstellung).
• Manuelle Indizierung
  Die Indizierung kann durch Platzhalter und deren entsprechende Index-Attribute vorgegeben werden.

Manuell definierte Indices (Unabhängig vom Einsatzzweck) werden immer im erzeugten Text angezeigt.

Ein vorgegebener Index wird automatisch auch für Parameter nachfolgender Objekte verwendet, falls diese nicht auch explizit einen Index definieren. Beispiel: Da für Pump1 ein Index von 10 definiert wird, wird für Pump2 automatisch der Index 11 verwendet. Pump1 : FB_BA_View := (iLabel:=SomeLabel, sObjectName := '{Idx=10}'); Pump2 : FB_BA_View := (iLabel:=SomeLabel);

Manuell vergebene Indices müssen sorgfältig vergeben werden da diese nicht vom Mechanismus validiert werden!

Verkettung

Die Texte eines Objektes werden unter bestimmten Bedingungen mit Texten von Parent-Objekten verkettet:

• Parent-Einstellung
• Einstellungen im verwendeten DPAD-FB
• Manuelles Überschreiben mittels Index-Attributen
• Globale Einstellungen
• Platzhalter mit Verkettungs-Verbot

Use-cases

• Anwendungsfall 1
  Ein Platzhalter bezieht sich auf einen bestimmten Parameter.
  Beispiel: Initialisierung des ObjectName
  sObjectName := '{}'
• Anwendungsfall 2
  Ein Platzhalter repräsentiert einen anderen Parameter.
  In diesem Fall muss der Platzhalter mit seinem entsprechenden Kürzel angesprochen werden.
  Beispiel:
  sDescription := '{} - ID {InstID}'.

Parameter

Attribute

Attribute werden typischerweise in der Applikation (Zum Beispiel in einem Template) verwendet, da dort die Applikations-spezifischen Details bekannt sind, nicht aber die Betreiber-spezifischen Details.

• Index-Attribute
  Ob ein Index sich auf ein Aggregat oder eine Funktion bezieht ist abhängig von der Reihenfolge.
• Ein alleinstehender Index bezieht sich auf die Funktion.
• Zwei Indices beziehen sich auf das Aggregat (Index 1) und die Funktion (Index 2)

Syntax

• Platzhalter:
  {}
• Platzhalter, der einen Parameterwert überschreibt (z.B. sObjectName := '{MyValue}'):
  {Value}
• Platzhalter, als repräsentierendes Attribut (z.B. sDescription:= '{Idx}'):
  {Attribute}
{Attribute1,Attribute(n),...}
• Platzhalter, als definierendes Attribut (z.B. sDescription:= '{Idx=10}'):
  {Attribute=Value}
{Attribute1=Value,Attribute(n)=Value,...}
• Platzhalter, als definierendes Attribut welcher einen Parameter Wert überschreibt (z.B. sDescription:= '{Pump{Idx=10}}'):
  {Value{Attribute=Value}}
• Platzhalter mit mehreren Attributen:
  {Placeholder{Attribute1=Value,Attribute2=Value}}
• Platzhalter, als repräsentierender Parameter (e.g. sDescription:= '{} {InstID}'):
  {Parameter}
• Platzhalter, der die Verkettung mit Elternelementen verweigert. Es wird der Einstiegspunkt der Verkettung definiert. Ab diesem Punkt werden nur Platzhalter der Kinderelemente verkettet:
  !{}
• Platzhalter, der bestimmte Attribute verweigert (ausschalten von Attributen):
  {Value{!Attribute}}

Beispiele

Parameter ObjectName mit definiertem Platzhalter (vertettet automatisch generierte Werte):
sObjectName := '{}'

Verkettet Parameter ObjectNamemit überschriebenen Wert:
sObjectName := '{AAA01_BB01}'

Verkettet Parameter Description mit Platzhalter und fest definierten Zusatzinformationen, die nicht ersetzt werden:
sDescription := '{} North'

Verkettet Parameter Description mit einem Platzhalter und erweitert ein stellvertretendes index-attribut (Es wird der Indexwert vom ObjectName übergeben):
sDescription := '{Idx}'

Verketteter Parameter ObjectName mit Platzhalter inklusive definierendem Index-Attribut:
sObjectName := '{Idx=10}'

Verketteter Parameter ObjectName mit Platzhalter inklusive stellvertretendem (Aggregat) und definiertem (Funktion) Index-Attribut:
sObjectName := '{Idx,Idx=10}'

Verketteter Parameter Description mit überschriebenem Wert und einem definiertem (Funktion) Index-Attribut:
sDescription := '{Pump{Idx=5}}'

Verketteter Parameter Description mit Platzhalter und einem stellvertretenden Parameter:
sDescription := '{} - ID {InstID}'

ObjectName mit Standardplatzhalter aber ohne Verkettung (Verkettung verweigert):
sObjectName := '!{}'

Verketteter Parameter ObjectName mit überschriebenem Wert, aber ohne Index-attribut (Attribut verweigert):
sDescription := '{PU{!Idx}}'

Fehlermeldungen

Generieren von Texten

Die folgende Reihenfolge wird verwendet, um zu entscheiden, wie ein Platzhalter ersetzt wird:

1. Texte überschreiben
   Falls definiert, wird ein manuell initialisierter Titel verwendet:
   fbSensor : FB_BA_AO_IO := (sObjectName:='Tmp03', sDescription:='Temperature sensor 3');
2. Labels
   Wenn Titel nicht überschrieben werden, kann ein Label angewendet werden:
   SomeLabel : FB_BA_Label := (sName:='PU', sDescription:='Pumpe');
Pump : FB_BA_View := (iLabel:=SomeLabel);
3. SymbolName
   Wenn nichts definiert ist, werden die folgenden Standardwerte verwendet:
• ObjectName erhält die Information vom symbolpath.
• Description erhält die Information vom symbolname.

Samples

Initialisierung mittels Labels

Übertragung der, im Label definierten Texte, auf Objekte.

{region 'Labels in GVL "MyLabels"'}
  MV    : FB_BA_Label    := (sName:='MW',  sDescription:='Messwert');
  TFl    : FB_BA_Label    := (sName:='TFL',  sDescription:='Vorlauftemperatur');
  TRt    : FB_BA_Label    := (sName:='TRL',  sDescription:='Rücklauftemperatur');
  PreHtr    : FB_BA_Label    := (sName:='LE',  sDescription:='Lufterhitzer');
     
  TFl_MV    : FB_BA_Label2x    := (iAggregate:=TFl,  iFunction:=MV);
  TRt_MV    : FB_BA_Label2x    := (iAggregate:=TRt,  iFunction:=MV);
{endregion}
{region 'Objects in some program'}
  PreHtr    : FB_BA_View    := (      iLabel:=MyLabels.PreHtr);
  TFl    : FB_BA_AI_Raw    := (iParent:=PreHtr,  iLabel:=MyLabels.TFl_MV);
  TRt    : FB_BA_AI_Raw    := (iParent:=PreHtr,  iLabel:=MyLabels.TRt_MV);
{endregion}