Allgemeine Einführung: Abgeleitete Parameter und Funktionsformate
Die Werte abgeleiteter Parameter werden über angegebene Funktionen abgerufen. Bei den Funktionen kann es sich um benutzerdefinierte Java-Funktionen oder standardmäßige Systemfunktionen handeln. Die folgenden Funktionsformate sind im System definiert:
• dg_inherit_from_ancestor
Gibt den Wert des Quellparameters des Vorgängerelements auf der angegebenen Ebene zurück. Sie verwendet die Parameter format_property, level und default_format:
◦ format_property ist der Name eines Parameters.
◦ levelist 0 oder eine positive Ganzzahl. Der Wert 1 bezeichnet das unmittelbare Elternteil. Der Wert 2 bezeichnet die 2. Elterngeneration. Der Wert 0 gibt das oberste Vorgängerelement an.
◦ default_format ist ein Funktionsformat (optional).
dg_inherit_from_ancestor(rating, 1) gibt z.B. den Wert des Parameters rating des unmittelbaren Elternteils zurück.
• dg_inherit_from_connected
Diese Funktion gibt den Wert für den Parameter aus, und zwar durch Verfolgung der Verbindungen in der angegebenen Richtung und mit dem angegebenen Diagrammtyp. Sie sucht so lange, bis ein Artefakt mit dem angegebenen Quellparameter auf der angegebenen Ebene gefunden wird oder bis die vom Parameter level festgelegte Ebene erreicht ist. Sie verwendet die Parameter direction, diagram_type_name, source und level:
◦ direction gibt die Verfolgungsrichtung an. Mögliche Werte sind forward oder reverse.
◦ diagram_type_name ist der Name des Diagrammtyps, in dem gesucht wird.
◦ source ist der Name des Quellparameters. Wenn dieser Parameter nicht definiert ist, wird standardmäßig der Name des Parameters der Funktion verwendet.
◦ levelist 0 oder eine positive Ganzzahl. Der Wert 1 bezeichnet den verbundenen Anschluss. Der Wert 2 bezeichnet das Elternteil des Anschlusses. Der Wert 0 gibt das oberste Vorgängerelement an. Falls der Wert nicht festgelegt wird, ist die Voreinstellung 1. Der Parameter für die Ebene legt die maximale Ebene fest, bis zu der die Verfolgung durchgeführt wird, und nicht die Ebene, aus der der Parameterwert abgerufen wird. Wenn beispielsweise level=2 und der Parameter am Anschluss und am Elternteil vorhanden sind, wird der Wert vom Anschluss abgerufen. Hierbei handelt es sich um die erste Ebene, auf der der Parameter bei der Verfolgung gefunden wird.
|
|
Diese Funktion gibt nur Parameterwerte von einem verbundenen Objekt zurück. Wenn z.B. mehrere Drähte mit demselben Anschluss verbunden werden, wird der erforderliche Parameterwert nur von einem Draht zurückgegeben.
|
• dg_derive_from_enclosure
Gibt den Wert des Quellparameters des grafisch eingeschlossenen Objekts mit dem angegebenen Quelltyp zurück. Wenn kein grafisch eingeschlossenes Objekt gefunden wird, gibt die Funktion den voreingestellten Standardwert zurück. Sie verwendet die Parameter source_type, source_property und default:
◦ source_type ist der Typpfad.
◦ source_property ist der Parametername.
◦ default ist der Standardwert.
Beispiel:
dg_derive_from_enclosure(component!housing, location, unplaced) gibt den Wert des Positionsparameters aller Elemente vom Typ component!housing zurück, die dieses Element einschließen. Ist kein einschließendes Objekt vorhanden, wird der Wert unplaced zurückgegeben.
• dg_derive_indirect
Gibt den Berechnungswert des angegebenen Formatparameters als Funktionsformat aus. Wenn das Objekt keinen Formatparameter hat oder der Wert keine Zeichenfolge ist, gibt die Funktion das Berechnungsergebnis des Standardformats als Funktionsformat aus. Sie verwendet die Parameter format_property und default_format:
◦ format_property ist der Name eines Parameters.
◦ default_format ist ein Funktionsformat (optional).
Beispiel:
dg_derive_indirect(alternative_format,dg_inherit_from_ancestor(default, 0)) gibt den Berechnungswert von dg_inherit_from_ancestor(default, 0) zurück. Wurde der String-Parameter alternative_format definiert, gibt die Funktion das entsprechende Berechnungsergebnis zurück.
• dg_derive_indirect2
Gibt den Berechnungswert des angegebenen Formatparameters als Beschriftungsformat aus. Wenn das Objekt keinen Formatparameter hat oder der Wert keine Zeichenfolge ist, gibt die Funktion das Berechnungsergebnis des Standardformats als Beschriftungsformat aus. Sie verwendet die Parameter format_property und default_format:
◦ format_property ist der Name eines Parameters.
◦ default_format ist ein Beschriftungsformat (optional).
Beispiel:
dg_derive_indirect2(alternative_format, default)gibt den Berechnungswert zurück, wenn Sie den String-Parameter alternative_format festlegen. Andernfalls wird der Wert default ausgegeben, als Ergebnis der Berechnung von default als Beschriftungsformat. Wenn Sie den zurückgegebenen Wert in dg_derive_indirect verwenden, wird der Fehlerwert *Procedure 'default' does not exist* ausgegeben.
|
|
dg_derive_indirect verwendet den zweiten Parameter als Funktionsformat. dg_derive_indirect2 verwendet den zweiten Parameter als Beschriftungsformat.
|
• dg_derive_as_label
Gibt den Berechnungswert der angegebenen Formatfunktion als Beschriftungsformat aus. Sie verwendet den Parameter dg_derive_as_label(label_format). In diesem Fall ist label_format ein Beschriftungsformat, z.B. [dg_xref].
|
|
Wenn Sie eine Funktion in einer benutzerdefinierten Java-Methode formatieren, schließen Sie den Funktionsnamen in geschweifte Klammern { } ein. Um z.B. die statische Methode user_derived aus der Klasse UserFunctions zu verwenden, definieren Sie den Funktionsnamen als {UserFunctions.user_derived}.
|
