派生パラメータと関数フォーマットについて
派生パラメータは、特定関数により値を取得するものです。関数には、カスタマイズされた Java 関数とデフォルトのシステム関数があります。システムには、以下の関数フォーマットが定義されています。
• dg_inherit_from_ancestor
指定されたレベルの祖先のソースパラメータの値を返します。format_property、level、および default_format パラメータを使用します。
◦ format_property はパラメータの名前です。
◦ level は 0 または正の整数です。この値が 1 の場合、すぐ上の親を意味します。この値が 2 の場合、2 つ上の親を意味します。この値が 0 の場合、トップレベルの祖先を意味します。
◦ default_format は関数フォーマット (オプション) です。
たとえば、dg_inherit_from_ancestor(rating, 1) は、すぐ上の親の rating パラメータの値を返します。
• dg_inherit_from_connected
指定したダイヤグラムタイプを使用して指定の方向全体にわたって接続をトレースすることによって、パラメータの値を返します。指定したソースパラメータを持つ加工品が、指定したレベルに見つかるか、または level パラメータによって定義されたレベルに達するまでサーチが実行されます。direction、diagram_type_name、source、および level パラメータを使用します。
◦ direction はトレースする方向です。可能な値は forward または reverse です。
◦ diagram_type_name はトレースするダイヤグラムタイプの名前です。
◦ source はソースパラメータの名前です。このパラメータが定義されていない場合、この関数を使用しているパラメータの名前がデフォルトで設定されます。
◦ level は 0 または正の整数です。この値が 1 の場合、接続ポートを意味します。この値が 2 の場合、ポートの親を意味します。この値が 0 の場合、トップレベルの祖先を意味します。このパラメータが指定されていない場合、デフォルトで 1 に設定されます。level パラメータには、関数によってトレースされる最大レベルを定義します。パラメータの値を取得するレベルではありません。たとえば、level=2 で、このパラメータがポートおよびその親に存在する場合、値はポートから取得されます。この場合、パラメータが取得される場所は、トレースでパラメータが検出される 1 番目のレベルです。
 |
この関数は、接続している 1 つのオブジェクトからのみパラメータ値を返します。たとえば、複数のワイヤが同じポートに接続されている場合、要求されたパラメータ値は 1 つのワイヤからのみ返されます。
|
• dg_derive_from_enclosure
指定されたソースタイプを持つ、図形的に囲まれたオブジェクトのソースパラメータの値を返します。そのような図形的に囲まれたオブジェクトが見つからない場合、関数は指定されたデフォルト値を返します。source_type、source_property、および default パラメータを使用します。
◦ source_type はタイプパスです。
◦ source_property はパラメータ名です。
◦ default はデフォルト値です。
例:
dg_derive_from_enclosure(component!housing, location, unplaced) は、タイプ component!housing によって囲まれる任意のアイテムの位置パラメータの値を返します。囲んでいるオブジェクトがない場合、値 unplaced を返します。
• dg_derive_indirect
関数フォーマットとして、指定されたフォーマットパラメータの値を評価した結果を返します。オブジェクトがフォーマットパラメータを含んでいない場合、または値が文字列でない場合、関数は関数フォーマットとしてデフォルトフォーマットを評価した結果を返します。format_property および default_format パラメータを使用します。
◦ format_property はパラメータの名前です。
◦ default_format は関数フォーマット (オプション) です。
例:
dg_derive_indirect(alternative_format,dg_inherit_from_ancestor(default, 0)) は dg_inherit_from_ancestor(default, 0) を評価した値を返します。文字列パラメータ alternative_format が指定されている場合、値を評価した結果を返します。
• dg_derive_indirect2
ラベルフォーマットとして、指定されたフォーマットパラメータの値を評価した結果を返します。オブジェクトがフォーマットパラメータを含んでいない場合、または値が文字列でない場合、関数はラベルフォーマットとしてデフォルトフォーマットを評価した結果を返します。format_property および default_format パラメータを使用します。
◦ format_property はパラメータの名前です。
◦ default_format はラベルフォーマット (オプション) です。
例:
文字列パラメータ alternative_format を設定した場合、dg_derive_indirect2(alternative_format, default) は値を評価した結果を返します。それ以外の場合は、値 default を返します。これは、ラベルフォーマットとして default を評価した結果です。返された値を dg_derive_indirect で使用すると、エラー値 *Procedure 'default' does not exist* が返されます。
|
|
dg_derive_indirect では、2 番目のパラメータを関数フォーマットとして使用します。dg_derive_indirect2 では、2 番目のパラメータをラベルフォーマットとして使用します。
|
• dg_derive_as_label
ラベルフォーマットとして、指定されたフォーマット関数を評価した結果を返します。dg_derive_as_label(label_format) パラメータを使用します。この場合、label_format はラベルフォーマットです (例: [dg_xref])。
|
|
ユーザー定義の Java メソッドで関数をフォーマットする場合、関数名を中括弧 { } で囲みます。たとえば、UserFunctions クラスの静的メソッド user_derived を使用するには、関数名を {UserFunctions.user_derived} と指定します。
|