コンテンツにスキップ

Tclコマンドリファレンス#

大文字・小文字の区別とスラッシュ

以下のコマンドでは大文字と小文字が区別されます。パスを指定するにはスラッシュを使用してください。

情報

個々のコマンドのパラメータを記述するために以下で使用される表記法は、Wirth構文記法（WSN）に基づいています：

  • 波括弧内のパラメータ名は、コマンドラインでこのパラメータに値を指定しない、1つの値を指定する、または複数の値を指定できることを示します。
  • 角括弧内のパラメータ名は、省略可能なパラメータを示します。

設計の作成、読み込み、保存#

LoadDesign#

コマンド構文
LoadDesign FileName

デザインを読み込むためのコマンド FileName。ファイルシステム内のファイルへのパスとファイル名を FileName ファイルシステム上のファイルのパスとファイル名自体。ファイル名の拡張子（*.vaまたは*.tcl）を指定することを忘れないでください。デザインファイルへのパスを指定するにはスラッシュを使用してください。

例： LoadDesign c:/VA_TCL/BaseAreaGray8.va

すでにデザインが読み込まれている場合：コマンド CloseDesign を使用して、現在読み込まれているデザインを閉じます LoadDesign.

CreateDesign#

コマンド構文
CreateDesign Name Platform

ハードウェアプラットフォーム Platformに対して、名前 Nameを持つ新しいデザインを作成するためのコマンドです。デザインのターゲットプラットフォームを指定するには、以下のいずれかを使用できます

  • プラットフォーム用の VisualApplets ライブラリ名（例：「iF-CXP12-Q」）、または
  • プラットフォームのフルネーム（例：「imaFlex CXP-12 Quad」）。スペースを含む引数に対するTcl構文の要件に従って、フルネームを引用符で囲むことを忘れないでください。

名前の大文字・小文字の使用は影響しません。

SaveDesign#

コマンド構文
SaveDesign FileName [SaveOption]

デザインを保存するためのコマンド： FileName。ファイルシステム内のファイルへのパスとファイル名を FileName ファイルへのパスとファイル名自体。デザインファイルへのパスを指定するには、スラッシュを使用します。

ファイル名にファイル名拡張子を追加するのを忘れないでください。

  • ファイル拡張子「.va」を指定した場合、デザインは標準のVisualAppletsデザイン形式で保存されます。ファイル内のすべてのコンテンツが保存されます。VisualAppletsデザインのプライマリデータ形式として、*.vaファイル形式を使用してください。
  • ファイル拡張子「.tcl」を FileNameで指定すると、Tclスクリプトがエクスポートされます。デザインの一部のコンテンツはエクスポートできません。

既存のファイルを上書きする場合は、オプションパラメータを設定します。 SaveOption を overwrite.

Tclスクリプトへのエクスポート中に、以下の情報が失われます：

  • ユーザーライブラリ要素のインスタンスで行ったローカルな変更（周囲のデザインにインスタンスを適応させるため）は失われます。TclスクリプトをVisualAppletsに再インポートした場合、インスタンスはユーザーライブラリ要素の新規コピーとして挿入されます。デザイン内のインスタンスの内容はTclに保存されていません。
  • 情報ボックスのテキストコンテンツはTcl形式で保持されます。ただし、情報ボックスのフォーマットは失われます。

ChangePlatform#

コマンド構文
ChangePlatform Platform FileName [SaveOption]

現在のデザインを別のハードウェアプラットフォームに変換し、 Platform 変換されたデザインを次として保存するためのコマンド： FileName.

利用可能なすべてのハードウェアプラットフォームの概要を取得するには、 ChangePlatform ? - 利用可能なすべてのハードウェアプラットフォーム名のリストが返されます。現在選択されているハードウェアプラットフォームがリストの最初のエントリに表示されます。

パラメータで目的のハードウェアプラットフォームの名前を指定します Platform。デザインのターゲットプラットフォームを指定するには、次のいずれかを使用できます。

  • プラットフォーム用の VisualApplets ライブラリ名（例：「iF-CXP12-Q」）、または
  • プラットフォームのフルネーム（例：「imaFlex CXP-12 Quad」）。

名前の大文字・小文字の使用は影響しません。 FileName ファイルへのパス（スラッシュを使用）、ファイル名自体、およびファイル名拡張子。既存のファイルを上書きする場合は、オプションパラメータを設定します。 SaveOption を overwrite.

CloseDesign#

コマンド構文
CloseDesign [Mode]

現在開いているデザインを閉じるためのコマンド。

オプションパラメータを設定した場合 Mode を Discard、まだ保存していない変更が含まれている場合でも、デザインは閉じられます。保存されていない変更は破棄されます。

を使用する場合、 CloseDesign パラメータを使用せずに Mode まだ保存していない変更がデザインに含まれている場合でも、コマンドは終了し、対応するエラーメッセージが表示されます。

SetDesignProperty#

コマンド構文
SetDesignProperty Key Value

現在読み込まれているデザインのデザインPropertyを入力するには、このコマンドを使用します。

使用できるキーは4つあります：

  • ProjectName (プロジェクトに付ける名前)
  • Version (デザインのバージョン)
  • Description (プロジェクトの説明)。

  • TargetRuntime (フレームグラバーでこのアプレットを実行するホストPCで使用されるオペレーティングシステムをここで指定します。)

    以下の値が許可されています：

    • Win64
    • Win32
    • Linux64
    • Linux32

例：

SetDesignProperty TargetRuntime Win64

SetDesignClock#

コマンド構文
SetDesignClock NewFrequency

FPGAの基本クロック周波数（MHz）を設定するためのコマンド。

デザインの開発#

CreateProcess#

コマンド構文
CreateProcess

新しいプロセスを作成するためのコマンド。VisualAppletsは新しいプロセスに自動的に番号を付けます。

DeleteProcess#

コマンド構文
DeleteProcess ProcName

名前を指定してプロセスを削除するためのコマンド ProcName.

例： DeleteProcess Process1

CreateModule#

コマンド構文
CreateModule OperatorType FullModuleName [InPortMultiplicity [OutPortMultiplicity {NamedPortMultiplicity}]]xPos yPos

オペレーターのインスタンス（モジュール）を作成し、 OperatorTypeデザインウィンドウ内でモジュールを配置するためのコマンド。

では、 OperatorType、インスタンスを作成したい特定のオペレーターの名前を単純に指定します。オペレーターが属するライブラリを指定する必要はありません。

Using FullModuleName により、デザイン内におけるモジュールの階層位置を定義します。

FullModuleName の構文は次のとおりです。

<HierLevelPath>/<ModuleName>

  • HierLevelPath は、デザイン内の特定の階層レベルへのパスを定義するために使用します。プロセスレベルから開始し、スラッシュを使用します。
  • ModuleName は、モジュールに付けたい名前を指定するために使用します。あるいは、 ModuleName を空のままにすることもできます。この場合、 FullModuleName をスラッシュで終了させる必要があります。モジュール名は自動的に割り当てられます。

デザインウィンドウにおけるモジュールの位置は、パラメータ xPos および yPos.

例：

CreateModule CxpCamera Process0/cam 123 163

を介して定義します。 CreateModule です。 FullModuleName （つまり、モジュール名を含む、モジュールへの完全な階層パス）を介して定義します。

オプションパラメータ InPortMultiplicity および OutPortMultiplicity:

多くのオペレータは固定数のポートでインスタンス化されます。一方、可変数のポートを持つオペレータもあります。可変数のポートを持つオペレータのインスタンス化時には、モジュールが持つポートの数を定義できます。

例えば、オペレータのインスタンス化時に BRANCH、インスタンスが持つ出力ポートの数を定義できます。

コマンド CreateModule: 出力の入力

このように、出力ポート数Oは可変です。ポート数が可変であるポートをマルチポートと呼びます。

マルチポートはベースネームによって識別されます。例えば、 BRANCHにおいて、出力ポートのベースネームは Oです。ベースネームに追加されるインデックスを介して、特定のポートを識別し、アドレス指定することができます。

コマンド CreateModule: マルチポート

コマンドを使用する場合 CreateModuleを使用すると、オプションの値ペア InPortMultiplicity および OutPortMultiplicity を使用して、モジュールのベクター入力とベクター出力の多重度を指定できます。これにより、たとえば BRANCH または ADD.

例：

CreateModule BRANCH Process0/branchz 1 3 43 123

コマンド CreateModule: 3つの出力ポートを持つBRANCHの例

デフォルト：使用しない場合 InPortMultiplicity および OutPortMultiplicityなどの、可変数のポートを持つオペレーターのインスタンス（モジュール）内のポート数を定義できます。または、これらを 0 に設定した場合、モジュールはデフォルトの入力ポートおよび出力ポート数で作成されます（つまり、2 つの値のいずれかまたは両方を 0 に設定しても、入力ポートや出力ポートがゼロになることはありません）。デフォルトで作成されるポートの数は、オペレーターの種類によって異なります。

例：

CreateModule BRANCH Process0/branch 43 123

コマンド CreateModule: 2つの出力ポートを持つBRANCHの例

デフォルトのポート数（1つの入力ポートと2つの出力ポート）が作成されます。

CreateModule BRANCH Process0/branch3 0 3 43 123

コマンド CreateModule: 3つの出力ポートを持つBRANCHの例

1 つの入力ポート（デフォルト）と 3 つの出力ポートが作成されます。

CreateModule BRANCH Process0/branch3 3 3 43 123

コマンド CreateModule: 3つの出力ポートを持つBRANCHの例

1 つの入力ポートと 3 つの出力ポートが作成されます。オペレーターの種類で許可されている入力は 1 つのみであるため、3 つの入力ポートの定義は無視されます。

CreateModule BRANCH Process0/branch4 0 4 43 123

コマンド CreateModule: 4つの出力ポートを持つBRANCHの例

オプションパラメータ NamedPortMultiplicity: 各種マルチポートを持つオペレーター（つまり、入力 I または出力 O 以外のマルチポートを持つオペレーター）の場合、パラメータ NamedPortMultiplicity を使用して、モジュールに配置するマルチポートのベース名を指定し、このマルチポートの多重度（数）を指定できます。フォーマットは NamedPortMultiplicity です。 MultiportBaseName:Number。使用できます NamedPortMultiplicity 1つのコマンドラインで複数回使用します。使用 NamedPortMultiplicity は、パラメータで指定した内容よりも優先されます InPortMultiplicity または OutPortMultiplicity.

例：

CreateModule BRANCH Process0/branch 0 0 O:3 100 100

このコマンド例の処理内容は次のとおりです。オペレータのインスタンス（モジュール）を作成します BRANCH。トップレベルのプロセス0に配置し、branchという名前を付けます。3つの出力ポート（マルチポートのベース名は出力用のO）を用意し、デザインウィンドウ内の位置y=100ピクセル、x=100ピクセルにモジュールを配置します。

の場合 MultiportBaseNameVA GUIで見つかるマルチポートのベース名を使用します。 MultiportBaseName 名前は、ポート数が可変のオペレータをインスタンス化するときに表示されるダイアログに表示されます。マルチポートのベース名は、マルチポートの短縮名です（GUIでは括弧内に表示されます）。

コマンド CreateModule: 入力の入力

ここでのマルチポートのベース名は I.

マルチポートのベース名は、ポート上のマウスオーバー情報からも確認できます。

コマンド CreateModule: マルチポートのマウスオーバー

ここでのマルチポートのベース名はIです（その後にマルチポートの個々のインスタンスを識別するインデックスが続きます I モジュール上）。

InstUserLibOperator#

コマンド構文
InstUserLibOperator LibName OperatorName FullModuleName xPos yPos

ユーザーライブラリエレメントをインスタンス化するためのコマンドです。パラメータを介してユーザーライブラリを指定します LibNameパラメータを介してライブラリ内の要素（オペレータ）の名前を指定します。 OperatorNameパラメータを介して、デザイン内でモジュールに付ける名前と、階層内のモジュールを配置する場所を指定します。 FullModuleName、およびパラメータを介したデザインウィンドウ内のモジュールの位置 xPosおよび YPos.

InstCustomLibOperator#

コマンド構文
InstCustomLibOperator LibName OperatorName FullModuleName xPos yPos

カスタムライブラリエレメントをインスタンス化するためのコマンドです。パラメータを介してユーザーライブラリを指定します。 LibNameパラメータを介してライブラリ内の要素（オペレータ）の名前を指定します。 OperatorNameパラメータを介して、デザイン内でモジュールに付ける名前と、階層内のモジュールを配置する場所を指定します。 FullModuleName、およびパラメータを介したデザインウィンドウ内のモジュールの位置 xPosおよび YPos.

DeleteModule#

コマンド構文
DeleteModule FullModuleName

モジュールを削除するためのコマンドです。 FullModuleName.

FullModuleName の構文は次のとおりです。 <HierLevelPath>/<ModuleName>.

  • HierLevelPath は、モジュールが配置されているデザイン内の階層レベルへのパスを指定するために使用します。プロセスレベルから開始します。スラッシュを使用してください。
  • ModuleName 削除するモジュールの名前を指定するために使用します。

シミュレーションモジュールはこのコマンドでは削除できません。シミュレーションモジュールを削除するには、次のコマンドを使用します： DeleteSimModule.

ConnectModules#

コマンド構文
ConnectModules FromModule FromModuleOutputPort ToModule ToModulePort [x1 [y2 x3]]

モジュールポートを接続するためのコマンドです。

パラメータ FromModule および ToModule は、次の構文を持つ階層名です： <HierLevelPath>/<ModuleName>.

内部階層ボックスノード（つまり、階層ボックスポートを接続するための内部ノード）は、プレフィックスによって識別されます INBOUND# または OUTBOUND#.

例：下図の階層ボックスの2つのインバウンドノードは、次のように指定する必要があります： INBOUND#I000 および INBOUND#I001.

コマンド ConnectModules: インバウンド接続

オプションのパラメータ x1, y2および x3 を使用すると、接続ポリゴンのジオメトリを定義できます：位置 FromModuleOutputPort X位置へ x1、Y位置への垂直線 y2、X位置への水平線 x3までの水平線、 ToModulePortの高さまでの垂直線、 ToModulePort.

コマンド ConnectModules: 接続ポリゴンのジオメトリの例 1

例：

ConnectModules Process0/CxpCamera O Process0/FrameBufferMultiRoi I 90 500 120

コマンド ConnectModules: 接続ポリゴンのジオメトリの例 2

DisconnectModules#

コマンド構文
DisconnectModules FullModuleName ModulePort

ポートに接続されているリンクを削除するためのコマンド ModulePort モジュールの FullModuleName.

例：

DisconnectModules Process0/Cam1 O

CreateComment#

コマンド構文
CreateComment FullBoxName Text xPos yPos

コメントボックスを作成するためのコマンド。

の構文は FullBoxName です。 <HierLevelPath>/<BoxName>.

  • HierLevelPath は、デザイン内の特定の階層レベルへのパスを定義するために使用します。プロセスレベルから開始し、スラッシュを使用します。
  • BoxName コメントボックスに付ける名前を指定するために使用します。または、次のようにすることもできます BoxName を空のままにすることもできます。この場合、 FullBoxName をスラッシュで終了させる必要があります。モジュール名は自動的に割り当てられます。

例：

CreateComment Process0/MyComment "This is my comment." 400 400

コメントボックスの内容として Text Unicode文字を使用できます。コメントは必ず引用符で囲んで設定してください。ASCIIに含まれない文字を使用する場合は、Unicodeを表現するための適切なTCL構文を使用してください。例：

[encoding convertfrom utf-8 "A-Umlaut: \xc3\x84"]

デザインウィンドウにおけるコメントボックスの位置は、次のパラメータで定義します xPos および yPos.

を介して定義します。 CreateComment です。 FullBoxName 関数（コメントボックスの名前を含む、コメントボックスへの完全な階層パス）の戻り値。

DeleteComment#

コマンド構文
DeleteComment FullBoxName

コメントボックスを削除するためのコマンド FullBoxName.

の構文は FullBoxName です。 <HierLevelPath>/<BoxName>.

  • HierLevelPath コメントボックスが配置されているデザイン内の階層レベルへのパスを指定するために使用します。プロセスレベルから開始し、スラッシュを使用します。
  • BoxName 削除したいコメントボックスの名前を指定するために使用します。

例：

DeleteComment Process0/MyComment

ボックス名に関する情報：削除したいコメントボックスの名前を取得するには、TCLを使用してデザイン内に配置されているボックスをクエリできます。VisualAppletsインストールフォルダ内のTCLのサンプルである QueryDesign.tcl を参照してください <VA installation directory>\Examples\AdvancedVAFunctions\Tcl Scripting\QueryDesign.tcl.

SetModuleParam#

コマンド構文
SetModuleParam FullModuleName ParameterName [FieldIndex] Value {OtherValues}

モジュールパラメータを設定するためのコマンド。

情報

このコマンドは、既存のパラメータを特定の値に設定する場合にのみ使用してください。メタデータパラメータの作成には使用できません（新しいメタデータパラメータを作成するには、次のコマンドを使用します SetParamString 代わりに。）

例：

SetModuleParam Process0/HierchBox1/module6 XLength 512

フィールドパラメータ：フィールドパラメータを参照する場合は、パラメータを指定する必要があります FieldIndex 指定する前に Value。フィールドパラメータを参照する場合にのみ、その後にさらなる値を指定できます Value.

フィールドパラメータを編集する例：

コマンドを入力する前に：

コマンド SetModuleParam: パラメータ編集の例

コマンドの入力

SetModuleParam Process0/module3 LUTcontent 4 12 13 14

次のような結果になります：

コマンド SetModuleParam: 値入力の例

コマンド SetModuleParam は、（使用するパラメータに応じて）次のコマンドと同じ機能を持ちます SetParamInt, SetParamFloat, SetParamEnum, SetParamString, SetParamIntFieldおよび SetParamFloatField。ただし、これらのコマンドはエクスポート専用です。

使用 SetModuleParam スクリプトを手動で記述する場合。

例外：新しいメタデータパラメータを追加する場合は、次を使用する必要があります SetParamString スクリプトを手動で記述する場合。コマンドの定義を参照してください SetParamString.

SetModuleParamProperty#

コマンド構文
SetModuleParamProperty FullModuleName ParameterName PropertyName PropertyValue {OtherPropertyValue}

モジュール Property の値を変更するためのコマンド。このコマンドは SetModuleParamTypeに置き換わる可能性があります。単一の Property 名が複数の値を持つ場合があります。以下の Property を変更できます：

access: 値として複数のフラグをここにリストできます：

  • write: パラメータをこの方向に切り替えられる場合（例えば、operator LinkParamTranslator内）、書き込みパラメータになります。
  • read: パラメータをこの方向に切り替えられる場合（例えば、operator LinkParamTranslator）、読み取りパラメータになります。
  • dynamic: パラメータが動的または静的のいずれかである場合、これにより動的パラメータになります（これはコマンド SetParamDynamicを使用します。
  • static: パラメータが動的または静的のいずれかである場合、これにより静的パラメータになります（これはコマンド SetParamStaticを使用します。

position: パラメータの整数値の定義 PropertyValueは、階層化されたボックス内のパラメータリストにおけるパラメータの位置を定義します。

SetParamInt#

コマンド構文
SetParamInt FullModuleName ParameterName Value

TCL エクスポート専用。整数パラメータを設定するためのコマンド。

情報

このコマンドは、VisualApplets から *.tcl ファイルへの TCL エクスポートで使用されます。

手動で作成したスクリプトでこのコマンドを使用しないでください。コマンド SetModuleParam コマンドを使用してください。

SetParamFloat#

コマンド構文
SetParamFloat FullModuleName ParameterName Value

TCL エクスポート専用。浮動小数点パラメータを設定するためのコマンド。

情報

このコマンドは、VisualApplets から *.tcl ファイルへの TCL エクスポートで使用されます。

手動で作成したスクリプトでこのコマンドを使用しないでください。コマンド SetModuleParam コマンドを使用してください。

SetParamEnum#

コマンド構文
SetParamEnum FullModuleName ParameterName Value

TCL エクスポート専用。アドレス指定された enum パラメータを設定するためのコマンド。 Value は、enum 値の文字列です。

例（オペレーターのインスタンスの場合、 SetSignalStatus はレベルに配置され、 Process0 という名前を持ち、 SetSigSt：

SetParamEnum Process0/SetSigSt Mode High

パラメータを設定します Mode オペレーターの SetSigSt は Process0 を High.

情報

このコマンドは、VisualApplets から *.tcl ファイルへの TCL エクスポートで使用されます。

手動で作成したスクリプトでこのコマンドを使用しないでください。コマンド SetModuleParam コマンドを使用してください。

SetParamString#

コマンド構文
SetParamString FullModuleName ParameterName Value

特定モジュールのメタデータパラメータを定義するには、このコマンドを使用します。

TCL エクスポートファイルでは、コマンド SetParamString は、既存のモジュールパラメータであっても、任意の文字列パラメータを設定するために使用されます。ただし、手動で作成するスクリプトではこれは実用的ではありません。

情報

独自のスクリプトを作成する際、モジュールパラメータの型が文字列型である場合でも、既存のモジュールパラメータに新しい値を設定するためにこのコマンドを使用しないでください。

既存のモジュールパラメータに新しい値を設定するには、常に次のコマンドを使用します SetModuleParam 。

SetParamIntField#

コマンド構文
SetParamIntField FullModuleName ParameterName Index Value {OtherValues}

TCLエクスポート専用に使用されます。整数型のフィールドパラメータを設定するためのコマンドです。フィールドを設定します Index を Value1の場合、指定された順序で次のフィールドに次の値が設定されます。

情報

このコマンドは、VisualApplets から *.tcl ファイルへの TCL エクスポートで使用されます。

手動で作成したスクリプトでこのコマンドを使用しないでください。コマンド SetModuleParam コマンドを使用してください。

SetParamFloatField#

コマンド構文
SetParamFloatField FullModuleName ParameterName Index Value {OtherValues}

TCLエクスポート専用に使用されます。浮動小数点型のフィールドパラメータを設定するためのコマンドです。フィールドを設定します Index を Value1の場合、指定された順序で次のフィールドに次の値が設定されます。

情報

このコマンドは、VisualApplets から *.tcl ファイルへの TCL エクスポートで使用されます。

手動で作成したスクリプトでこのコマンドを使用しないでください。コマンド SetModuleParam コマンドを使用してください。

SetParamStatic#

コマンド構文
SetParamStatic FullModuleName ParameterName

TCLエクスポート専用に使用されます。パラメータを静的にするためのコマンドです。パラメータを静的および動私の両方に設定できる場合、ほとんどの場合、パラメータはデフォルトで動的に設定されます。このようなパラメータを静的に設定するには、このコマンドを使用します。

情報

このコマンドは、VisualApplets から *.tcl ファイルへの TCL エクスポートで使用されます。

手動で作成したスクリプトでこのコマンドを使用しないでください。コマンド SetModuleParamType コマンドを使用してください。

SetParamDynamic#

コマンド構文
SetParamDynamic FullModuleName ParameterName

TCLエクスポート専用に使用されます。パラメータを動的にするためのコマンドです。パラメータが動的に設定可能な場合にのみ機能します。

情報

このコマンドは、VisualApplets から *.tcl ファイルへの TCL エクスポートで使用されます。

手動で作成したスクリプトでこのコマンドを使用しないでください。コマンド SetModuleParamType コマンドを使用してください。

SetModuleParamType#

コマンド構文
SetModuleParamType FullModuleName ParameterName TypeFlag {OtherTypeFlags}

パラメータのタイプを変更するためのコマンド。次のタイプフラグが利用可能です：

  • Dynamic: パラメータを動的または静的に設定できる場合、このフラグはパラメータを動的パラメータにします（コマンドを置き換えます SetParamStaticを使用します。
  • Static: パラメータを動的または静的に設定できる場合、このフラグはパラメータを静的パラメータにします（コマンドを置き換えます SetParamStaticを使用します。

Dynamic および Static 互いに排他的です。

型フラグを使用する場合 Dynamic または Static、このコマンドは次のコマンドと同じ機能を持ちます SetParamStatic および SetParamDynamic。ただし、次を使用します SetModuleParamType スクリプトを手動で記述する場合。

SetLinkParam#

コマンド構文
SetLinkParam FullModuleName PortName ParameterName Value {OtherParameterName OtherParameterValue}

リンクのフォーマットを設定するためのコマンドです。リンクは、モジュールの接続ノード（ポート）を介して識別されます。リンクフォーマットパラメータの名前は、VisualAppletsのGUIと同じです。

情報

TCLスクリプトを手動で作成する場合、このコマンドは変更可能なパラメータに対してのみ適用できます。変更できないリンクパラメータを設定しようとすると、次のようなエラーメッセージが表示されます。

コマンド SetLinkParam: 例

SetResourceMapping#

コマンド構文
SetResourceMapping FullModuleName ResourceName [Index] NewMapping

モジュールへのリソースのマッピングを変更するためのコマンドです。リソースは ResourceName は新しいインデックス NewMappingにマッピングされます。モジュールが同じタイプの複数のリソースを割り当てる場合は、オプションのパラメータ Index を使用してリソースを選択します。

コマンド構文
SplitLink FullModuleName PortName [Number]

モジュールを作成するためのコマンド BRANCH。新しいブランチモジュールは、モジュールから出力されるリンクに挿入されます FullModuleName ポート上 NodeName新しい分岐モジュールには、 Number 個の出力ポートがあります。オプションのパラメータを使用しない場合 Number新しい分岐モジュールには2つの出力ポートがあります。

を介して定義します。 SplitLink は、 FullModuleName 新しい分岐モジュールの（モジュール名を含む、モジュールへの完全な階層パス）。

デザイン構造とデザイン詳細のクエリ#

GetDesignProperty#

コマンド構文
GetDesignProperty PropertyName

このコマンドは設計プロパティを取得します。以下の値を指定できます： PropertyName:

  • ProjectName: プロジェクトの名前
  • FileName: 現在読み込まれているデザインファイル *.va のパスと名前
  • HardwarePlatform: ターゲットハードウェアプラットフォームのライブラリ名（例: iF-CXP12-Q）
  • Version: 設計のバージョン
  • Description: プロジェクトの説明
  • Loaded: デザインが読み込まれているかどうか（1または0）

Design property Loaded は、デザインがまったくロードされていない状態でも取得できます。これによりエラーメッセージは発生しません。デザインがロードされていない状態で他のDesign propertyを取得しようとすると、エラーメッセージが発生します。

GetDesignClock#

コマンド構文
GetDesignClock

このコマンドは、FPGAの基本クロック周波数（MHz）を返します。

GetProcesses#

コマンド構文
GetProcesses

このコマンドは、デザインのすべてのプロセスの名前のリストを返します。

GetSubModules#

コマンド構文
GetSubModules HierarchyName

このコマンドは、要求された階層に位置するモジュールの名前のリストを返します。 HierarchyName.

各サブモジュールについて、完全な階層名がリストされます。

GetParentHier#

コマンド構文
GetParentHier FullElementName

このコマンドは、指定された要素の親の階層名（FullModuleName）を返します FullElementNameつまり、 FullModuleName 階層要素の FullElementName に位置します。

FullElementName は、モジュール、シミュレーションモジュール、またはコメントボックスのいずれかです。

GetModules#

コマンド構文
GetModules Scope Specifier {ModuleList}

このコマンドは、デザイン内の特定のモジュールをフィルタリングします。このコマンドは、指定した特徴を持つモジュールのリストを次の項目を介して返します。 Scope および Specifierを介して指定した特性を持つモジュールのリストを返します。リストには、 FullModuleName 見つかったすべてのモジュール（個々のモジュール名を含むモジュールへのパス）に対して。デザイン全体ではなく、特定のモジュールセット内のみで検索する場合は、次の項目でそれらのモジュールを指定できます。 ModuleList （ FullModuleNameを使用します。

Scope には次の値を含めることができます。

  • pattern： Specifier を FullModuleNameのワイルドカード表現として使用します。指定子として「*」を指定すると、デザイン内のすべてのモジュールが返されます。
  • flat： Specifier を、モジュールの FullModuleName モジュールの（パターンと同様）。階層ボックスは返されません。
  • ordered：デザインのすべてのモジュールを返します。 Specifier ソートパターンを定義するには、次のオプションがあります:
    • path：モジュールはデザイングラフ内の位置によってソートされます（つまり、シミュレーション中にデータストリームがモジュールを通過する順序）。
    • name：モジュールは FullModuleName.
  • operatorType： Specifier を使用して、検索しているモジュールのオペレータータイプ（「O」、「M」、「P」、「O+P」、「M+P」、「unknown」）を定義します。
  • operator：特定のおよびすべてのインスタンスを取得するため。 Specifier を使用してオペレーター名（「NOP」など）を指定します。
  • libraryType： Specifier 特定のマニュアルライブラリタイプを定義します。このタイプのライブラリに含まれるオペレーターのインスタンスであるデザイン内のすべてのモジュールが返されます。許可される値：operator、user、custom（ GetModulePropertyを使用します。
  • library： Specifier を参照）特定のライブラリを定義します。このライブラリのオペレーターのインスタンスであるすべてのモジュールが返されます。
  • version： Specifier 特定 Operator のバージョンを定義するためです。このバージョンの Operator のインスタンスであるすべてのモジュールが返されます。

GetModulePorts#

コマンド構文
GetModulePorts FullModuleName [Scope]

このコマンドは、指定されたモジュールのすべてのポートの名前のリストを返します。オプションのパラメータを使用できます Scope を使用すると、特定のポートでフィルタリングできます。

  • inputs: 入力ポートのみが返されます
  • outputs: 出力ポートのみが返されます
  • all: モジュールのすべてのポートが返されます（デフォルト）

GetModulePortProperty#

コマンド構文
GetModulePortProperty FullModuleName PortName Property

このコマンドは、モジュールポートの Property を取得します。以下の値が Property で使用可能です：

  • isConnected: ポートが接続されている場合は 1 を返し、そうでない場合は 0 を返します。
  • position: ダイアグラム（デザインウィンドウ）内の指定されたポートの位置をリストとして返します（xPos, yPos)。もし PortName : 内側の階層ボックスノードを指定します（例: INBOUND#I000）、階層ボックスデザインウィンドウ内でのこのノードの位置が返されます。

GetModuleProperty#

コマンド構文
GetModuleProperty FullModuleName Property

このコマンドは、モジュールの Property を返します。

以下の値が Property で使用可能です：

  • status：モジュールがエラー状態でない場合は0を返します。それ以外の場合はエラーコードを返します。
  • operator: モジュールがインスタンスであるオペレータの名前を返します。例： BRANCH.
  • operatorType: オペレータタイプ (O、P、M、unknown) を返します。階層化されたボックスおよびユーザーライブラリのモジュールに対しては "Unknown" が返されます。
  • libraryType: オペレータの元となるライブラリのライブラリタイプを返します。以下のいずれかの値が返されます： operator, user, custom.
  • version: モジュールがインスタンスであるオペレータのバージョンを返します。
  • type: モジュールタイプを返します。以下のいずれかの値が返されます： process, hierBox, operator, user, custom.
  • isHierModule：指定されたモジュールにサブモジュールを含める機能がある場合は1を返します。指定されたモジュールにサブモジュールを含めることができない場合は0を返します。
  • isProtected：モジュールが保護されたライブラリ要素のインスタンスである場合は1を返します。
  • library: オペレータの元となるライブラリの名前を返します。
  • position: デザインウィンドウ内の位置をリストとして返します (xPos, yPosを使用します。
  • resources：ペアのリストを返します（ResourceName,ResourceMapping)
  • name: モジュール名を返します。

GetModuleParams#

コマンド構文
GetModuleParams FullModuleName {ParameterNames}

モジュールパラメータとその現在の値のリストを返します。

モジュールのすべてのパラメータを現在設定されている値とともに取得するには、次のコマンドを使用します。 GetModuleParams パラメータのみ FullModuleName.

例：

コマンド GetModuleParams: 例

特定のパラメータの値のみを取得する場合は、出力の対象をパラメータに制限することができます {ParameterNames}。出力の順序は、指定したパラメータ名の順序に対応します {ParameterNames}.

例：

Tcl Command GetModuleParams: Example with {ParameterNames}

puts [GetModuleParams Process0/FrameBufferMultiRoi RamDataWidth MaxFrameCount]

GetModuleParamProperty#

コマンド構文
GetModuleParamProperty FullModuleName ParameterName Property

パラメータPropertyを取得するためのコマンドです。

パラメータ Propertyでは、以下の値を利用できます。

  • status：パラメータがエラー状態でない場合は0を返します。それ以外の場合はエラーコードを返します。
  • type：パラメータのタイプを返します： int, intField, float, floatField, enum、または string.
  • access：アクセスの方向を返します： write または readを使用します。
  • unit: パラメータの単位を返します。
  • range: 整数および浮動小数点のデータ型の場合、コマンドは3つのエントリを含むリストとして値の範囲を返します。 Min, Max, Step。enumパラメータの場合は、enum名とenum値のペアのリストを返します。
  • size: フィールドのサイズを返します。対象： IntField および FloatField パラメータ。
  • isDynamic：要求されたパラメータが動的である場合は1を返します。それ以外の場合は0を返します。
  • isStatic：要求されたパラメータが静的である場合は1を返します。それ以外の場合は0を返します。
  • isEditable：要求されたパラメータを編集できる場合は1を返します。それ以外の場合は0を返します。

GetLinkParams#

コマンド構文
GetLinkParams FullModuleName PortName {ParameterNames}

特定リンクのリンクパラメータ名と現在設定されている値のリストを返します。リンクは、モジュールの接続ノード（ポート）を介して識別されます。返されるリストには値のペアが記載されています <ParameterName><Value> これは、経由でリンクパラメータを設定するときに使用するペアに対応します SetLinkParam.

リンクのすべてのパラメータを現在設定されている値とともに取得するには、次のコマンドを使用します GetLinkParams パラメータのみ FullModuleName および PortName.

特定のパラメータの値のみを取得する場合は、出力の対象をパラメータに制限することができます {ParameterNames}。出力の順序は、指定したパラメータ名の順序に対応します {ParameterNames}.

例：

Tclコマンド GetLinkParams: 例

GetLinkParamProperty#

コマンド構文
GetLinkParamProperty FullModuleName PortName ParameterName Property

このコマンドは、特定のリンクパラメータの Property を取得します。

パラメータの以下の値 Property が可能です:

  • status：パラメータがエラー状態でない場合は0を返します。それ以外の場合はエラーコードを返します。
  • isEditable：パラメータ値を変更できる場合は1を返します。それ以外の場合は0を返します。
  • range:
    • For integer data types, the command returns the value range either as a list containing three elements (Min, Max, Step), or as a list containing all allowed values. You distinguish the two kinds of lists as follows: The Min-Max-Step list contains 3 list elements; the third list element is smaller or equal to the second list element. A list stating all allowed values starts with the smalles value and ends with the highest value. If only one value is allowed, the value is returned in format {Value Value 1}, for example, { 4 4 1} for min=4, max=4, step=1.
    • 列挙型（enum）パラメータの場合、コマンドは列挙型名と列挙型値のペアのリストを返します。

GetLinkProperty#

コマンド構文
GetLinkProperty FullModuleName PortName Property

このコマンドは、特定のリンクの特定のPropertyを返します。 FullModuleName および PortName, を用いて階層ボックスのポートを指定する場合、階層ボックス内にこのポートへの、またはこのポートからのリンクが存在する限り、コマンドは正常に機能します。

パラメータの以下のオプション Property で使用可能です：

  • status: すべてが正常な場合（つまり、リンクソースとリンクターゲットのパラメータ設定が一致し、DRCでエラーが検出されない場合）は0を返します。それ以外の場合はエラーコードを返します。
  • from: リンクの起点となる始点を返します。始点は、先行モジュールの out ポート、またはリンクが接続されている内部階層ボックスノード（INBOUND#...) リンクが接続されている先。このコマンドは、2つの値を含むリストを返します。 FullModuleName および PortName.
  • to: リンクの終点を返します。終点は、後続モジュールの in ポート、またはリンクが接続されている内部階層ボックスノード（OUTBOUND#...) リンクが接続されている先。このコマンドは、2つの値を含むリストを返します。 FullModuleName および PortName.
  • source: 値のペアを含むリストを返します。 FullModuleName および PortName リンクのソースに至るまでのすべての先行リンクに対して返します。リンクチェーンは階層を逆方向にたどり、で指定したモジュールから FullModuleName 始点まで戻ります。返されたリスト内の要素の順序は、ルックアップの逆方向の経路に対応しています（ソースモジュールがリストの最後のエントリになります）。
  • dest: 値のペアを含むリストを返します。 FullModuleName および PortName リンクのターゲットモジュールに至るまでのすべての後続リンクに対して返します。リンクチェーンは階層を順方向に進み、で指定したモジュールから FullModuleName 終端（シンク）まで進みます。返されたリスト内の要素の順序は、ルックアップの順方向の経路に対応しており、ターゲットモジュール（送信先）がリストの最後のエントリになります。
  • hasConnectedSimModule: シミュレーションモジュールがリンクに接続されている場合は1を返し、シミュレーションモジュールが接続されていない場合は0を返します。
  • connectedSimModule: 接続されているシミュレーションモジュールの階層名を返します。

GetSimModules#

コマンド構文
GetSimModules Type Scope Specifier

このコマンドは、以下を取得します。 FullModuleName シミュレーションソース（Type = source）またはシミュレーションプローブ（Type = probe）のデザイン内での。このコマンドは、パラメータで指定した特性を持つシミュレーションモジュールのリストを返します。 Scope および Specifierを介して指定した特性を持つモジュールのリストを返します。リストには、 FullModuleNames （個別のパスを含む、個々のシミュレーションモジュールへの階層パス）。

Scope は次のオプションを提供します:

  • hierarchy: パラメータで特定の階層を定義します。 Specifier.
  • pattern: パラメータを使用します。 Specifier を FullModuleNames シミュレーションモジュールの。指定子として "*" を指定すると、デザインのすべてのソースまたはプローブシミュレーションモジュールが返されます。

GetCommentBoxes#

コマンド構文
GetCommentBoxes Scope Specifier

このコマンドは、デザイン内のコメントボックスを取得します。このコマンドは、パラメータで指定した特性を持つすべてのコメントボックスのリストを返します。 Scope および Specifierを介して指定した特性を持つモジュールのリストを返します。リストには、 FullElementNames （ボックス名を含む階層名）。

Scope は次のオプションを提供します:

  • hierarchy: 特定の階層を定義します（ HierLevelPathを経由して） Specifier.
  • pattern： Specifier を、モジュールの FullElementName コメントボックスの。指定子として "*" を指定すると、デザイン内のすべてのコメントボックスが返されます。

GetCommentProperty#

コマンド構文
GetCommentProperty FullBoxName Property

このコマンドは、コメントボックスの Property を取得します。

FullBoxName の構文は次のとおりです。 <HierLevelPath>/<BoxName>.

  • HierLevelPath コメントボックスが配置されているデザイン内の階層レベルへのパスを指定するために使用します。プロセスレベルから開始し、スラッシュを使用します。
  • BoxName コメントボックスの個別名を指定するために使用します。

Property には次のオプションがあります:

  • content: コメントボックスの内容が返されます。
  • position: デザインウィンドウ内のコメントボックスの左上隅のXおよびY位置が返されます。

ボックス名情報: 詳細を取得したいコメントボックスの名前を取得するには、TCLを使用してデザイン内に配置されているボックスをクエリできます。TCLの例を参照してください。 QueryDesign.tcl あなたのVisualApplets インストールフォルダ (例:<YourVisualAppletsInstallationDirectory>\Examples\AdvancedVAFunctions\Tcl Scripting\QueryDesign.tcl)

デザインの編集 – その他のコマンド#

Move#

コマンド構文
Move FullModuleName [HierNodeName] PosX PosY

モジュール、階層ボックスノード、コメントボックス、またはシミュレーションモジュールをデザインウィンドウ内の新しい位置に再配置するためのコマンドです。

パラメーターを使用する [HierNodeName] 階層ボックスノードを選択する場合のみ。階層ボックス内のノードは、プレフィックスによって識別されます。 INBOUND# または OUTBOUND#（コマンドを使用するときと同じように） ConnectModules）、 例えば、 INBOUND#I000.

Select#

コマンド構文
Select FullModuleName [PortName]

モジュール、シミュレーションモジュール、コメントボックス、またはリンクを選択するためのコマンド。パラメータを使用します。 PortName リンクを選択するためだけに使用されます（リンクは、リンクとアドレス指定されたモジュールを接続するポートによって識別されます）。

ClearSelection#

コマンド構文
ClearSelection [ParentHierarchy]

要素の選択範囲（モジュール、階層ボックスノード、リンク、コメントボックス、またはシミュレーションモジュール）を削除するコマンド。

オプションパラメータの ParentHierarchy を使用して、階層レベル上のすべての要素の選択を解除します。 ParentHierarchy.

を使用しない場合、 ParentHierarchy要素の選択は全体的に削除され、コマンド実行後は設計内のどの要素も選択されなくなります。

CopySelected#

コマンド構文
CopySelected [ParentHierarchy]

階層レベルで選択した要素をコピーするコマンド ParentHierarchy。オプションパラメータを使用しない場合、 ParentHierarchy現在アクティブなデザインウィンドウの階層レベルで選択されている要素がコピーされます。

DeleteSelected#

コマンド構文
DeleteSelected [ParentHierarchy]

階層レベル上の選択された要素を削除するコマンド。 ParentHierarchyで指定した階層レベルの選択されたモジュールのみが削除され、他のレベルの選択されたモジュールは保持されます。オプションパラメータを使用しない場合、 ParentHierarchy が削除されると、他のレベルで選択されたモジュールは残ります。オプションのパラメーターを使用しない場合 ParentHierarchy現在アクティブなデザインウィンドウの階層レベルで選択されている要素が削除されます。

CutSelected#

コマンド構文
CutSelected [ParentHierarchy]

階層レベル上の選択された要素を切り取るコマンド。 ParentHierarchy。オプションパラメータを使用しない場合、 ParentHierarchy現在アクティブなデザインウィンドウの階層レベルで選択されている要素が切り取られます。

GetSelected#

コマンド構文
GetSelected Scope [ParentHierarchy]

階層レベル上の選択された要素のリストを返します。 ParentHierarchyスコープを使用すると、選択したモジュールのリスト (Modules)、選択したリンクのリスト (Links)、選択したシミュレーション モジュール (SimModules)、または選択されたコメントボックス (CommentBoxesを使用します。

オプショナルパラメータを使用しない場合、 ParentHierarchy現在アクティブなデザインウィンドウの階層レベルにある選択された要素が返されます。

を使用する場合、 Scope = Modules/SimModules/CommentBoxes、リスト FullModuleNames （モジュール名を含む、各モジュールへの階層パス）が返されます。

を使用する場合、 Scope = Links リンクを識別するタプルのリストを取得します。 FullModuleName および PortName （リンクが接続されているポート）

Paste#

コマンド構文
Paste [ParentHierarchy] [xPos yPos]

クリップボードから階層レベルに要素を貼り付けるためのコマンド ParentHierarchy（つまり、以前にコピーまたは切り取られた要素を貼り付けます）。

オプショナルパラメータを使用しない場合、 ParentHierarchy、要素は現在アクティブなデザインウィンドウの階層レベルに貼り付けられます。

オプションのパラメーターを使用する xPos および yPos デザインウィンドウ内で挿入されたコンテンツの左上の位置を定義するため。

InsertModulePort#

コマンド構文
InsertModulePort FullModuleName PortName [Where]

ポートの隣に新しいモジュールポートを挿入するためのコマンド PortName.

情報

コマンド内で多重度を指定できるポートのみを挿入できます。 CreateModule.

Whereには次のオプションがあります。

  • before または above: 新しいポートは、指定したポートの直前に挿入されます。 PortName.
  • after または below: 新しいポートは、指定したポートの直後に挿入されます。 PortName （デフォルト）。

オプショナルパラメータを使用しない場合、 Where、新しいポートはポートの直後に挿入されます PortName.

RemoveModulePort#

コマンド構文
RemoveModulePort FullModuleName PortName

モジュールポートを削除するためのコマンドです。

情報

コマンド内で多重度を指定できるポートのみを削除できます CreateModule。指定された種類のポートの最小数は常に維持されます。最小数をさらに下回ろうとすると、対応するエラーメッセージが表示されます。例：Branchオペレーターの3番目の出力ポート（ポート名：O002）は削除できますが、最小である2つの出力ポート（O001およびO000）は削除できません：

Command RemoveModulePort

AppendModulePort#

コマンド構文
AppendModulePort FullHierBoxName Direction

階層ボックスに入力ポートまたは出力ポートを追加するためのコマンドです。

FullHierBoxName は、次の構文と同じ構文を持ちます。 FullModuleName.

Direction=input: 入力ポートが作成されます。

Direction=output: 出力ポートが作成されます。

Rename#

コマンド構文
Rename FullModuleName NewName

モジュールまたはシミュレーションボックスの名前を変更するためのコマンドです。 NewName では、階層パスを含めないインスタンス固有の新しい名前を指定します。

例：

Rename Process0/module1 DMA

SetActiveWindow#

コマンド構文
SetActiveWindow Hierarchy

VisualAppletsで階層の設計ウィンドウを開く（およびアクティブに設定する）ためのコマンド。 Hierarchy イン VisualApplets。

GetActiveWindow#

コマンド構文
GetActiveWindow

VisualAppletsで現在開いておりアクティブになっているデザインウィンドウの階層レベルに関する情報を返します。

デザインのシミュレーション#

CreateSimSource#

コマンド構文
CreateSimSource FullSimModuleName xPos yPos

シミュレーションソースモジュールを作成し、デザインウィンドウ内に配置するためのコマンドです。

FullSimModuleName の構文は次のとおりです。 <HierLevelPath>/<SimModuleName>

  • HierLevelPath デザイン内の特定の階層レベルへのパスを定義するために使用します。
  • SimModuleName は、シミュレーションソースモジュールに設定する固有の名前を指定するために使用します。または、次のようにすることもできます。 SimModuleName を空のままにすることもできます。この場合、 FullSimModuleName をスラッシュで終了させる必要があります。モジュール名は自動的に割り当てられます。

を介して定義します。 CreateSimSource は、 FullModuleName （モジュール名を含む、シミュレーションソースモジュールへの完全な階層パス）。

CreateSimProbe#

コマンド構文
CreateSimProbe FullSimModuleName xPos yPos

シミュレーションプローブモジュールを作成し、デザインウィンドウ内でモジュールを配置するためのコマンドです。

FullSimModuleName の構文は次のとおりです。 <HierLevelPath>/<SimModuleName>

  • HierLevelPath デザイン内の特定の階層レベルへのパスを定義するために使用します。
  • SimModuleName シミュレーションプローブモジュールに付与する名前を指定するために使用します。または、以下のようにすることもできます SimModuleName を空のままにすることもできます。この場合、 FullSimModuleName をスラッシュで終了させる必要があります。モジュール名は自動的に割り当てられます。

を介して定義します。 CreateSimProbe は、 FullModuleName 新しいシミュレーションプローブモジュールの（モジュール名を含むシミュレーションプローブモジュールへの完全階層パス）。

DeleteSimModule#

コマンド構文
DeleteSimModule FullSimModuleName

シミュレーションモジュール（シミュレーションソースまたはシミュレーションプローブ）を削除するためのコマンドです。

の構文は FullSimModuleName は、次の構文と同じです。 FullModuleName.

ConnectSimModule#

コマンド構文
ConnectSimModule FullSimModuleName TargetModuleName TargetModulePortName [xPos yPos]

シミュレーションモジュールをリンクに接続するためのコマンド。リンクは、それが接続されているモジュールポートで特定します。

の構文は FullSimModuleName および TargetModuleName は、次の構文と同じです。 FullModuleName。の構文 TargetModulePortName は、次の構文と同じです。 PortName.

モジュール TargetModuleName およびシミュレーションモジュール FullSimModuleName それらを互いに接続するには、同じ階層に配置する必要があります。

オプションで、リンク上の接続ポイントの位置を次のように定義できます。 xPos および yPos.

DisconnectSimModule#

コマンド構文
DisconnectSimModule FullSimModuleName

シミュレーションモジュールをリンクから切り離すためのコマンドです。

SetSimModuleProperty#

コマンド構文
SetSimModuleProperty FullSimModuleName Key Value {OtherValue}

シミュレーションモジュールのPropertyを定義するためのコマンドです。

使用 Key 設定するPropertyを特定します。各Propertyを以下の形式で設定します。利用可能なPropertyと対応する値のフォーマットは以下の通りです:

pixelAlignmentOffset BITS

アライメントオフセットを整数値で指定するには、このパラメータを使用します BITS.

imageFileSubPixels NUMBER

1つのリンクピクセルに割り当てられるファイルピクセルの数を整数値で指定するには、このパラメータを使用します NUMBER.

ソース: NUMBER ピクセルが1つのピクセルに統合されます。

プローブ：1つのピクセルが以下に分割されます NUMBER ファイル内のピクセル。

imageFilePixelBits BITS

このパラメータを使用して、画像ファイル内の Bit Width を整数値として指定します BITS。許可される値は 1、8、および 16 です。

imageFileNormalize CHOICE

この Property を使用して、シミュレーション結果画像を保存する方法を設定します。

1ビットのシミュレーション結果を8ビットのファイル形式で保存する場合は、 imageFileNormalize を 1 に設定します。ここでの「正規化（Normalizing）」とは、0 を 0（黒）に、1 を 255（白）にマッピングすることを意味します。

以下の値が CHOICE が可能です: CHOICE = "1" | "0"

cropRect [imageNr] X Y WIDTH HEIGHT

この Property はシミュレーションソースでのみ使用できます。画像インデックスの指定は [imageNr] 必須です。このパラメータを使用して画像を切り抜き、シミュレーションで使用する画像の領域（ROI）を指定します。 X および Y を使用して、ROI の左上の角を定義します。

currentImage INDEX

このパラメータを使用して、シミュレーションモジュール内の画像を選択します。 INDEX を整数値として指定します。

AddImage#

コマンド構文
AddImage FullSimModuleName ImageFileName1 {OtherImageFileName} [ImageLibrary]

シミュレーションソースモジュールに画像を追加するためのコマンド。シミュレーションソースが接続されているリンクのカーネル要素の数が 1 より大きい場合は、カーネルが持つ要素数と同数の画像を指定する必要があります。

必要に応じて、使用するイメージライブラリを指定できます（ ImageLibrary = "Native" | "ImageMagick"）。

RemoveImage#

コマンド構文
RemoveImage FullSimSourceName {ImageIndex}

シミュレーションソースモジュールから1枚またはすべての画像を削除するためのコマンド。オプションパラメータ ImageIndex を使用して、削除する画像を指定します。 ImageIndex を -1 に設定した場合、または ImageIndex をまったく使用しなかった場合は、シミュレーションモジュール内のすべての画像が削除されます。

Simulate#

コマンド構文
Simulate ProcessingCycles [SaveLogfilename]

デザインをシミュレーションするためのコマンドです。コマンドで実行する処理サイクル数を定義するには、パラメータ ProcessingCycles を使用します。

オプションパラメータの SaveLogfilename 実行したサイクルのログをファイルに保存します。ファイルへのパスとファイル名を SaveLogfilename で指定します。ログは HTML 形式で書き込まれるため、ファイル名拡張子として *.html を使用してください。パスを示すにはスラッシュを使用してください。

例：

Simulate 1 c:/temp/simlog.html

ResetSimulation#

コマンド構文
ResetSimulation

シミュレーションエンジンをリセットするためのコマンドです。これにより、デザイン内のすべてのシミュレーションプローブがクリアされます。

GetSimModuleProperty#

コマンド構文
GetSimModuleProperty FullSimModuleName Property [ImageIndex [LineIndex [LineCount] ] ]

シミュレーションモジュールの Property を取得するためのコマンドです。以下の Property が使用可能です：

  • isConnected: シミュレーションモジュールがリンクに接続されている場合は 1 を返し、そうでない場合は 0 を返します。
  • connectedLink: 以下を含むリストを返します： FullModuleName リンクが接続されているモジュールの、およびリンクが接続されているモジュールのポート。戻り値は常に実際のモジュールポートによってリンクを記述するため、内部の H ボックスノードを示すことはありません（例えば、 INBOUND#I000 または OUTBOUND#O000を使用します。
  • isSource: シミュレーションモジュールが SimulationSourceである場合は 1 を返し、そうでない場合は 0 を返します。
  • isProbe: シミュレーションモジュールが SimulationProbeである場合は 1 を返し、そうでない場合は 0 を返します。
  • position: プログラムウィンドウ内でのシミュレーションモジュールの位置をリストとして返します（xPos, yPosを使用します。
  • imageCount: シミュレーションモジュール内の画像数を返します（ IMAGECOUNTを使用します。
  • imageSize: パラメータ ImageIndex の使用は必須です。で指定した画像のサイズを ImageIndex としてリストで返します {Width <WIDTH> Height <HEIGHT>}.
  • pixelAligmentOffset: アライメントオフセットを整数値として返します BITS.
  • imageFileSubPixels: リンクピクセルに割り当てられたファイルピクセルの数を整数値として返します NUMBER.
  • imageFilePixelBits: 画像ファイル内の Bit Width の設定を整数値として返します BITS。許可される値は 1、8、および 16 です。
  • imageFileNormalize: シミュレーション結果画像を保存する設定に応じて、1または0を返します。1に設定されている場合、1ビットのシミュレーション結果を8ビットの*形式でファイルに保存する際に format: 0 は 0（黒）にマッピングされ、1 は 255（白）にマッピングされます。つまり、シミュレーション画像のフォーマットは「正規化」されます。
  • cropRect: この Property はシミュレーションソースでのみ利用可能です。パラメータの使用 ImageIndex が必須となります。以下のエントリを含むリストを返します。 {X Y WIDTH HEIGHT}.
  • currentImage: 現在選択されている画像を整数値として返します INDEX.

SetSimImageData#

コマンド構文
SetSimImageData FullSimModuleName ImageIndex KernelRow KernelCol Component X Y Width Value {OtherValues}

シミュレーションモジュール（ソースまたはプローブ）内の画像で、1ピクセルまたは複数の隣接ピクセルを上書きするためのコマンド。

このコマンドを使用できます_

  • シミュレーション用画像を加工するために SimSources で使用します。
  • 画像内の結果を可視化するために SimProbes で使用します。

画像の変更内容は一時的なものです。同じシミュレーションモジュールの別の画像を選択するか、変更した画像を再度選択すると、変更した画像がハードディスクから新しく読み込まれ、変更内容は破棄されます（同じシミュレーションモジュールの新しい画像のコマンドをTCLコンソールに入力した場合、またはVisualApplets GUIのビューアで同じシミュレーションモジュールの別の画像をクリックした場合に、別の画像を選択したことになります）。 ImageIndex （シミュレーションモジュールの）

ただし、変更した画像がアクティブである限り、新しいファイル名で保存することで、変更内容を永続的なものにすることができます。

一時的に変更した画像をシミュレーションに使用できます。ただし、シミュレーションに使用できるのは、SimSourceモジュールあたり1つの画像のみです（同じSimSourceで別の画像を変更すると、先ほど変更した画像のピクセル値がリセットされるため）。シミュレーションモジュールあたり1つだけ一時的に変更した画像がある限り、必要な数だけ一時的に変更した画像をシミュレーションに使用できます。

ピクセルあたり1つの値: コマンド SetSimImageData を使用すると、1ピクセルあたり正確に1つの値を書き込むことができます。したがって、グレースケールピクセルでは、コマンドを SetSimImageData 1回だけ実行して、ピクセルあたりの完全なカラー情報を書き込む必要があります。カラーピクセルでは、ピクセルあたり3つのカラーコンポーネントのうち1つしか書き込むことができません。したがって、カラーピクセルのすべてのカラーコンポーネントを変更する場合は、コマンドを SetSimImageData 3回実行する必要があります。

カーネル付き画像への書き込み：カーネルを持つ画像に書き込む場合、コマンドを使用する際に、（上書きする（最初の）ピクセルの正確な位置に加えて）それぞれのピクセルのどのカーネル要素を上書きするかを指定する必要があります SetSimImageData。すべてのカーネル要素を上書きする場合は、コマンドを SetSimImageData 正確に KernelRow * KernelCol 回実行します。

コマンドを使用するには：

コマンドを使用する前に、変更したい画像があるシミュレーションモジュールの画像ビューアを閉じます。

インデックスで変更する画像を特定します ImageIndex.

ImageIndex は0から始まりますが、VisualApplets GUIのシミュレーションモジュールにおける画像の番号付けは1から始まります。値は次のように対応します：

ImageIndex = 0 は、VisualApplets GUIのビューアの画像1を指します。

ImageIndex = 1 は、VisualApplets GUIのビューアの画像2を指します。

ImageIndex = 2 は画像3を指します

、以下同様です。

情報：VisualAppletsのGUIでは、次のシミュレーションサイクルで使用される画像のインデックスが括弧 [ ] で囲まれ、プレフィックスとして "sim" が付いて表示されます（例：sim[2]）。

使用 KernelRow および KernelCol ピクセル値を変更するカーネル要素を指定するには、

シミュレーション画像のカーネルサイズは、シミュレーションモジュールが接続されているリンクのリンクプロパティで確認できます。カーネルサイズが1ピクセルより大きいリンクの前には常に、カーネルを指定できるオペレータのインスタンスが置かれます（例：オペレータ FIRkernelNxMを使用します。

カーネルの列と行のカウントは0から始まります。したがって、要素が1つだけのカーネルの場合は、両方の値（KernelRow および KernelCol）を0に設定します：

SetSimImageDataコマンド：Kernel ColumnsとKernel Rowsのカウント

4要素のカーネルの場合、個々のカーネル要素を次のように特定します：

SetSimImageDataコマンド：4要素におけるカーネル要素の特定

9要素のカーネルの場合、個々のカーネル要素を次のように特定します：

SetSimImageDataコマンド：9要素におけるカーネル要素の特定

パラメーターを使用します Component を設定するピクセルのカラーコンポーネントを指定します。グレースケール画像では、 Component を0に設定します。マルチコンポーネント画像（カラー）では、カラーモデル内の位置によって書き込みたいコンポーネントを指定します。例：RGB画像の赤成分を指定する場合は Component を0に設定し、RGB画像の緑成分を指定する場合は Component を1に設定し、RGB画像の青成分を指定する場合は Component を2に設定します。

位置を設定（X,Y) を使用して、画像内の書き込みの開始点（最初のピクセル）を定義します。

使用 Width 行ごとに上書きする隣接ピクセルの数を指定します。もし指定した数が Values 1行あたりに書き込むピクセル数よりも多い場合 (Width)、次の行の次の位置で書き込みが継続されます X。このようにして、以下の幅を持つROI (Region of Interest) に書き込むことができます Width.

個別のピクセル値を指定します Value {OtherValues} を先頭の「0x」なしの16進数で指定します。負の値は2の補数表現で指定します。指定する値の数は Value {OtherValues} 画像内で変更されるピクセルの数を決定します。

GetSimImageData#

コマンド構文
GetSimImageData FullSimModuleName ImageIndex KernelRow KernelCol Component X Y [Width [Height]]

シミュレーションモジュール（ソースまたはプローブ）内の画像で、1つまたは複数の隣接ピクセルの値を読み取るためのコマンド。

ピクセルあたり1つの値: コマンド GetSimImageData は1ピクセルあたり正確に1つの値を返します。したがって、グレースケールピクセルでは、コマンドを GetSimImageData ピクセルごとの完全なカラー情報を取得するために1回のみ実行します。カラーピクセルでは、ピクセルごとに3つのカラー成分のうち1つだけを取得できます。したがって、カラーピクセルのすべてのカラー成分を読み取る場合は、コマンド GetSimImageData 3回実行する必要があります。

カーネル付き画像の読み込み：カーネルを持つ画像から読み込む場合、コマンドを使用する際に、（読み込む（最初の）ピクセルの正確な位置に加えて）それぞれのピクセルのどのカーネル要素を読み込むかを指定する必要があります GetSimImageDataカーネルのすべての要素を読み込むには、コマンドを実行する必要があります。 GetSimImageData 正確に KernelRow * KernelCol 回実行します。

コマンドを使用するには：

インデックスを使用して画像を指定します ImageIndex.

ImageIndex は0から始まりますが、VisualApplets GUIのシミュレーションモジュールにおける画像の番号付けは1から始まります。値は次のように対応します：

ImageIndex = 0 は、VisualApplets GUIのビューアの画像1を指します。

ImageIndex = 1 は、VisualApplets GUIのビューアの画像2を指します。

ImageIndex = 2 VisualApplets GUIのビューアー内の画像3を指します。

、以下同様です。

情報：VisualAppletsのGUIでは、次のシミュレーションサイクルで使用される画像のインデックスが括弧 [ ] で囲まれ、プレフィックスとして "sim" が付いて表示されます（例：sim[2]）。

使用 KernelRow および KernelCol 読み取るカーネル要素を指定します。

シミュレーション画像のカーネルのサイズは、シミュレーションモジュールが接続されているリンクのリンクプロパティで確認できます。1要素よりも大きいカーネルサイズを持つリンクの前には常に、カーネルを指定できるオペレーターのインスタンス（例：オペレーター FIRkernelNxMを使用します。

カーネルの列と行のカウントは0から始まります。したがって、要素が1つだけのカーネルを持つ場合は、両方の値を0に設定します。

GetSimImageDataコマンド：Kernel ColumnsとKernel Rowsのカウント

4要素のカーネルの場合、個々のカーネル要素を次のように特定します：

GetSimImageDataコマンド：4要素におけるカーネル要素の特定

9要素のカーネルの場合、個々のカーネル要素を次のように特定します：

GetSimImageDataコマンド：9要素におけるカーネル要素の特定

パラメーターを使用します Component ピクセルから読み取るカラーコンポーネントを指定します。グレースケール画像の場合は、次のように設定します Component を 0 に設定します。マルチコンポーネント画像（カラー）の場合は、カラーモデル内の位置を介して読み取るコンポーネントを指定します。例：設定 Component RGB 画像の赤コンポーネントを読み取る場合は 0 に、設定 Component RGB 画像の緑コンポーネントを読み取る場合は 1 に、または設定 Component RGB 画像の青コンポーネントを読み取る場合は 2 に設定します。

位置を設定（X,Y) 画像内の読み取りの開始点（最初のピクセル）を定義します。

パラメータを使用しない場合 Width、正確に 1 ピクセルの値が返されます。指定するのが Width, Width の場合、行内の値 Y が返されます。指定した場合 Width および Height, Width * Height の値が返されます。使用することで Width および Height 、ピクセル値（グレー）/ ピクセルコンポーネントの値（カラー）を読み取る対象の関心領域（ROI）を定義できます。

各ピクセル値は、先頭に「0x」を付けずに16進数表記で返されます。負の値は2の補数表現で返されます。

GetSimImageProperty#

コマンド構文
GetSimImageProperty FullSimModuleName Property ImageIndex [LineIndex [LineCount] ]

シミュレーション画像（ソースまたはプローブモジュール内）の Property を取得するためのコマンド。

の以下の値 Property が利用可能です：

LineWidth：経由で定義 LineIndex どのラインの幅に関する情報を取得するかを指定します。を使用する場合 LineCount、複数の幅の値（リスト形式）を取得できます。最初の値はラインの幅になります LineIndex.

SaveImage#

コマンド構文
SaveImage FullSimProbeName {ImageIndex} ImageBaseName

シミュレーションプローブから 1 つまたはすべての結果画像を保存するためのコマンドです。

オプションパラメータの ImageIndex 結果画像の中から特定の画像を保存する場合。使用しないでください ImageIndex または、プローブのすべての画像を保存する場合は -1 に設定します。

使用 ImageBaseName を設定して、画像を保存するファイルシステムのディレクトリへのパスと、画像ファイルのファイル名を指定します。指定したディレクトリがファイルシステム内にすでに存在していることを確認してください。存在しない場合は、コマンドを使用して作成できます。 MakeDirectoryPath （そちらを参照）。

例：「c:\images\testimage」。保存プロセスでは、ファイル名の拡張子（例：*.tif）が名前に自動的に追加されます。

プローブのすべての画像を保存すると、ファイル名に画像インデックスが自動的に追加されます。

例 1：

入力

SaveImage Process0/mySimProbe c:/images/testimage

次のファイルを取得するには：

c:\images\testimage_0001.tif

c:\images\testimage_0002.tif

c:\images\testimage_0003.tif

…

例 2：

入力

SaveImage Process0/mySimProbe 4 c:/images/testimage

次のファイルを取得するには：

c:\images\testimage.tif

デザインのビルド#

Drc#

コマンド構文
Drc [SaveLogfileName]

デザインルールチェック（DRC 1）の第 1 レベルを開始するためのコマンド。

ログ出力を作成するには、パラメータでオプションとして HTML ログファイル（*.html）のパスと名前を指定できます [SaveLogfileName].

Drc2#

コマンド構文
Drc2 Name Platform

デザインルールチェック（DRC 2）の第 2 レベルを開始するためのコマンド。

ログ出力を作成するには、パラメータでオプションとして HTML ログファイル（*.html）のパスと名前を指定できます [SaveLogfileName].

SelectBuildConfiguration#

コマンド構文
SelectBuildConfiguration ConfigurationName

保存されたビルド構成をアクティブなビルド構成として選択するためのコマンド。

パラメータで目的のビルド構成の名前を指定します ConfigurationName.

利用可能なすべてのビルド構成の概要を取得するには、次を入力します SelectBuildConfiguration ? - 利用可能なすべてのビルド構成名のリストが返されます。現在選択されているビルド構成がリストの最初のエントリに表示されます。

例：

SelectBuildConfigurationコマンド

このコマンドは、現在選択されているビルド構成の名前を返します。この戻り値により、ビルド構成の再設定が成功したかどうかを確認できます。

例：

SelectBuildConfigurationコマンドの出力

ビルド#

コマンド構文
ビルド [SaveLogfilename [MaxTime] ]

ビルドフローを開始するためのコマンド。

ログ出力を作成するには、パラメータでオプションとして HTML ログファイル（*.html）のパスと名前を指定できます [SaveLogfileName].

ビルドプロセスの制限時間を設定するには、オプションでパラメータに最大ビルド時間を指定できます [MaxTime] （単位：時間）。パラメータ [MaxTime] の型は浮動小数点数です。これにより、時間の端数を指定できます。デフォルトの設定 [MaxTime] は 24 時間です。

ログファイルを作成するコマンドの例 build_log.html 最大ビルド時間を ½ 時間として指定します：

Build build_log.html 0.5

ファイル、パス、プログラムインスタンス、メッセージの処理#

Source#

コマンド構文
Source FilePath

ファイルからTCLスクリプトを実行するためのコマンド。パスを指定するにはスラッシュを使用します。このコマンドは、TCLコマンドの sourceと同様に機能しますが、次のプレースホルダーを自動的に置き換えます（コマンド MakeDirectoryPath：

%UserDir%: 現在のユーザーのユーザーデータディレクトリ（例：c:/Users/Smith）

%AppDataDir%: VisualAppletsのアプリケーションデータ用ディレクトリ

%VaInstallDir%: VisualAppletsのインストールディレクトリ

%UserLibDir%: ユーザーライブラリ用ディレクトリ。

%CustomLibDir%: カスタムライブラリ用ディレクトリ。

%VaVersion%: VisualAppletsのプログラムバージョン（例："3.1"）

%CurrDateTime%: ISO 8601（基本形式）に準拠した現在の日時（例: "20170530T134522"）

%DateTime%: 開始日時VisualApplets ISO 8601（基本フォーマット）によると、例えば「20170530T134350」のようになる。

%CurrDesignDir%: 現在読み込まれているデザインが保存されているディレクトリ。

MakeDirectoryPath#

コマンド構文
MakeDirectoryPath FullPath

任意の深さのパス（およびそのディレクトリ）を作成するためのコマンド。

このコマンドは、以下のプレースホルダーを自動的に置き換えます：

%UserDir%: 現在のユーザーのユーザーデータディレクトリ（例：c:/Users/Smith）

%AppDataDir%: VisualAppletsのアプリケーションデータ用ディレクトリ

%VaInstallDir%: VisualAppletsのインストールディレクトリ

%UserLibDir%: ユーザーライブラリ用ディレクトリ。

%CustomLibDir%: カスタムライブラリ用ディレクトリ。

%VaVersion%: VisualAppletsのプログラムバージョン（例："3.1"）

%CurrDateTime%: ISO 8601（基本形式）に準拠した現在の日時（例: "20170530T134522"）

%DateTime%: 開始日時VisualApplets ISO 8601（基本フォーマット）によると、例えば「20170530T134350」のようになる。

%CurrDesignDir%: 現在読み込まれているデザインが保存されているディレクトリ。

コマンドが正常に実行されると、絶対パスが返されます。

GetAbsolutePath#

コマンド構文
GetAbsolutePath Path

パラメータで指定したパスの絶対パスを返します Path.

このコマンドは、コマンドと同じエイリアス名（プレースホルダー）を自動的に置き換えます MakeDirectoryPath.

存在しないディレクトリやファイルを Path で参照することが許可されており、結果として得られるパス名が、存在しないディレクトリやファイルを指すようになります。

待機#

コマンド構文
待機 TimeInMilliseconds

指定した時間待機するためのコマンド TimeInMilliseconds。待機中もVisualAppletsのGUIはアクティブなままになります。

次のように設定した場合： TimeInMilliseconds を0に設定すると、VisualAppletsによってGUIのイベントループ更新が少なくとも1回実行されます。これを利用して、GUIにそれ以前のコマンドの結果が表示されるようにすることができます。

メッセージ#

コマンド構文
メッセージ Type Code Text

以下のものを出力するためのコマンド：

  • エラー メッセージ（Type=error）、
  • 警告（Type=warning）、または
  • 情報メッセージ（Type=info)

では、 Codeは、メッセージのメッセージコードを定義します。 Code の値の範囲は-999から+999です。VisualAppletsの現在および将来のバージョンとの競合を避けるために、この範囲内の値のみを使用してください。

使用 Text を入力します。メッセージの末尾にはドットが自動的に付加されます。

終了#

コマンド構文
終了 [Mode]

現在の VisualApplets セッションを終了するためのコマンドです。次を使用できます： Exit デザインが開いたままであっても使用できます。ただし、その前に変更内容を保存することを忘れないでください。

デザインが開いたままで、そのデザインに未保存の変更が含まれている場合：

  • オプションパラメータを設定した場合 Mode を Discardまだ保存していない変更が含まれている場合でも、開いているデザインは閉じられます。未保存の変更は破棄されます。
  • を使用する場合、 Exit パラメータを使用せずに Mode オープンデザインに未保存の変更が含まれている場合でも、コマンドは終了し、対応するエラーメッセージを受け取ります。