Operator StringParamReference

Operator Library: Parameters

このオペレーターは、デザイン内のどこに位置するモジュールパラメーターからも、1:1のマップパラメーター(パラメーター「Value」内)を生成します。参照されるパラメーター(パスと名前)は、パラメーター「Reference」で指定します。

参照されるパラメーターは、VA_STRING、VA_FILENAME、VA_METADATAの3つのタイプのいずれかになります。マップパラメーターは常に文字列です。

参照されるパラメーターを表示およびアクセス可能にするデザイン階層内のターゲットを定義できます。ターゲットは、DisplayHierarchyとDisplayNameの2つのパラメーターによって定義されます。DisplayHierarchyでは、参照オペレーター自体が配置されているプロセスと同じプロセス内の階層ボックスを指定します。パラメーター DisplayNameでは、ターゲットパラメーターの名前を設定します。DisplayHierarchyとDisplayNameの両方が設定されている場合、DisplayNameで定義されたパラメーターは、DisplayHierarchyで指定された階層ボックス内で利用可能になります。DisplayNameが空の場合、パラメーターは作成されません。DisplayNameが設定されている一方でDisplayHierarchyが空の場合、DisplayNameで定義されたパラメーターは親階層(つまり、参照オペレーター自体が配置されている階層ボックス)に追加されます。

これにより、デザインのパラメータを任意の階層レベル(デザインの)で使用できるようになります。たとえば、保護された階層ボックス内のモジュールのパラメータを、保護された階層ボックス自体の Property の下で直接パラメータ化できるようにすることができます。

マップパラメータ自体を参照することもできます。したがって、リファレンスオペレーター内のパラメータ Value のコンテンツを参照するか、パラメータ DisplayName および DisplayHierarchy で定義したパラメータを参照することができます。これは、保護された階層ボックスが他の保護された階層ボックスから構築されている場合に特に重要です。

[注] 接続されているすべてのパラメーターが一度に更新されます

接続されたパラメータのいずれかが変更された場合(参照されるパラメータ、マップパラメータの Value、またはターゲットパラメータ)、他のすべての接続されたパラメータの値も同様に変更されます。

このオペレーターは、設計のデータフロー構造に干渉しないため、入力と出力を持っていません。

ライブラリ Parameters の一般的な紹介については、Library Parameters を参照してください。

例:

Process0/Level0/Level1でパラメータ「CoeffFileParam」が利用可能になりました。

I/O Property

Property 値
オペレータータイプ なし(入力または出力がないため)

サポートされているリンクフォーマット

None

パラメーター

Status
タイプ 静的読み取り(GUIには書き込みと表示されます)パラメータ
Default なし
範囲 OKまたはエラーメッセージ

エラーステータスを表示します。パラメータ Activate が Yes に設定されている場合、 他のモジュールパラメータがチェックされます。 このパラメータには、このチェックの結果(OK またはエラーメッセージ)が表示されます。

このパラメータは最終的なアプレットの一部ではありません。

DisplayName
タイプ static write parameter
Default なし
範囲 任意の文字列

デザイン内の別の場所(参照オペレーターインスタンス自体に加えて)で、参照されるパラメーター(パラメーター Reference で定義)との間でアクセスを許可する場合は、新しいパラメーターを定義する必要があります。ここにこの新しいパラメーターの名前を指定します。このフィールドが空の場合、新しいパラメーターは作成されません。

DisplayHierarchy
タイプ static write parameter
Default なし
範囲 任意の文字列

パラメータ DisplayName で定義した新しいマップパラメータを追加する階層ボックスをここで指定します。

このパラメータでは、オートコンプリート機能と構文ハイライトを使用できます。オートコンプリートを使用するには、Module Properties ダイアログでこのパラメータの Parameter Values フィールドをクリックし、キーボードの TAB キーを押します。オートコンプリート機能の詳細な手順については、「Autocompletion and Syntax Highlighting for Translator and Reference Operators」を参照してください。

新しいパラメータ DisplayName を定義したが、パラメータ DisplayHierarchy を空のままにした場合、新しいパラメータは参照オペレータインスタンスを含む階層ボックスに追加されます(参照オペレータインスタンスが最上位(プロセス)レベルにある場合は実行できませんのでご注意ください)。

[注] 表示先へのパスを設定するための構文

デザイン内の別の場所に新しいパラメータを表示させたい場合は、パラメータ DisplayHierarchy で新しいパラメータを含む階層ボックスへのパスを指定する必要があります。

構文は以下のとおりです:

<Path> is the relative path from process level to the hierarchical level of the design where the <Hierarchical Box> is located that is to receive the new parameter. Thus, parameter DisplayHierarchy can only address hierarchical boxes within the same process. Use a slash as separator between different hierarchical levels.

<HierarchicalBox> is the name of the hierarchical box that is to receive the new map parameter.

例: Level0/Level1

値
タイプ static、dynamic、write、readパラメータ
Default 0
範囲 符号付き整数(64ビット)、符号なし整数(64ビット)

参照されるパラメータとの間でのアクセスのためのMap parameter。 このパラメータは、参照されるパラメータと同じPropertyを持ちます。

Reference
タイプ static write parameter
Default なし
範囲 参照されるパラメーターを定義する任意の文字列:モジュールへの相対パス、モジュール名、およびパラメーター名

ここでは、デザイン内での参照されるパラメーターの位置を定義します。

このパラメータでは、オートコンプリート機能と構文ハイライトを使用できます。オートコンプリートを使用するには、Module Properties ダイアログでこのパラメータの Parameter Values フィールドをクリックし、キーボードの TAB キーを押します。オートコンプリート機能の詳細な手順については、「Autocompletion and Syntax Highlighting for Translator and Reference Operators」を参照してください。

[注] 参照の構文

構文は以下のとおりです:

<Path> is the relative path to the hierarchical level where the referenced module "Module" is located. Use a slash as separator between different hierarchical levels. Define the path as relative path from the hierarchical level the reference operator instance is located in.

<Module> is the name of the module (operator instance or hierarchical box) that contains the referenced parameter.

<ParamName> is the actual name of the referenced parameter.

If <Path> starts with a slash, the path is interpreted as absolute path starting from design level (e.g., /Process0/UUT/CoeffBuffer.CoefficientFile0を使用します。

次を使用することもできます: ../ 階層を1つ上に移動します。ただし、自由に複製または再配置可能なモジュールを設計する際には、このオプションを使用しないよう注意してください。

Activate
タイプ 動的書き込みパラメータ
Default いいえ
範囲 {No,Yes}

Yes = 参照パラメータとの間のアクセス(マップパラメータ Value を経由)が有効になります。

No = 参照されるパラメーターへのアクセスが無効化され、パラメーター Statusが無効になります。パラメーター DisplayNameおよびDisplayHierarchyは効果を持ちません。

使用例

StringParamReferenceオペレーターの使用方法については、以下の例をご覧ください。