On this page | |
Since | 17.5 |
このノードを使用することで、エクスプレッションによって生成されるコマンドラインを持ったワークアイテムを生成することができます。 場合によっては、ネットワークを開始した時点では何もしない(コマンドラインが空っぽのままの)特定の数のワークアイテムを単に生成して、それらのワークアイテムにアトリビュートを追加して、それらのアトリビュートを使って下流のノードを駆動させるのにも役立ちます。
このノードは、入力がなくても Item Count ワークアイテムを生成します。 入力があれば、上流のワークアイテム毎に Item Count ワークアイテムを生成します。
もっと高度な機能が必要であれば、代わりにPython Processorノードを使用してください。
パラメータ ¶
Command Line ¶
Generate When
このノードがワークアイテムを生成するタイミングを決めます。 このノードがどの生成モードを必須にしているのか、もしくは、ワークアイテムを動的に生成させる必要があるのかどうか分からないのであれば、通常では、これを“Automatic”のままに設定してください。
All Upstream Items are Generated
このノードは、すべての入力ノードが自身のワークアイテムを生成した時にワークアイテムを生成します。
All Upstream Items are Cooked
このノードは、すべての入力ノードが自身のワークアイテムをクックした時にワークアイテムを生成します。
Each Upstream Item is Cooked
このノードは、入力ノード内のワークアイテムがクックされる度にワークアイテムを生成します。
Automatic
入力ノードの生成モードに基づいて生成モードが選択されます。 入力ノードのどれかがその入力のクック時にワークアイテムが生成されている場合、このノードには Each Upstream Item is Cooked が設定されます。 そうでない場合、 All Upstream Items are Generated が設定されます。
Cache Mode
ワークアイテムから目的のファイル結果がレポートされるように、プロセッサノードがそのワークアイテムを制御する方法を決めます。
Automatic
目的の結果ファイルがディスク上に存在すれば、そのワークアイテムはスケジュールに組まれずにクック済みとマークされます。 そのファイルが 存在しなければ 、そのワークアイテムは通常どおりにスケジュールに組まれます。 上流のワークアイテムの依存関係がクック中に新しいファイルを書き出す場合、このノード内のワークアイテムのキャッシュファイルもout-of-date(古い)としてマークされます。
Automatic (Ignore Upstream)
Automatic と同様ですが、上流のファイルの書き込みは、このノード内のワークアイテムのキャッシュファイルを 無効にしません 。 そして、このノードは自身のワークアイテムの出力ファイルのみをチェックします。
Read Files
目的の結果ファイルがディスク上に存在すれば、そのワークアイテムはスケジュールに組まれずにクック済みとマークされます。 そのファイルが存在しなければ、そのワークアイテムは失敗とマークされます。
Write Files
目的の結果ファイルがディスク上に存在していても、ワークアイテムが常にスケジュールに組まれ、その目的の結果ファイルを無視します。
Sequential
これを有効にすると、このノードから生成されるワークアイテムはお互いに依存するように作成されるので、それらのワークアイテムは同時ではなく順々に実行されます。 例えば、インデックス1のワークアイテムはインデックス0に依存し、インデックス2はインデックス1に依存します。 このノードがDynamicであれば、同じ親を持つ他のワークアイテムのみに対してワークアイテムをシーケンシャルにすることができます。
Copy Inputs to Outputs
これを有効にすると、このノード内のワークアイテムは、入力ファイルを出力ファイルリストに自動的にコピーします。 無効にすると、このノードは、コマンドラインで出力ファイルをワークアイテムに添付するものと想定します。
Flatten Work Item Indices
Item Count
入力のワークアイテム毎に生成する出力ワークアイテムの数を設定します。入力のワークアイテムが存在しなければ、このノードは、この数だけの出力ワークアイテムを生成します。
Index
デフォルトでは、このノードは、生成したワークアイテムに対して順々に0
から始まるindex
アトリビュートを付けます。
ただし、 Index が有効な場合、このノードは、このパラメータフィールドで指定されたエクスプレッションから独自のindex
値を生成します。
Flatten Indices が有効な場合、このパラメータを使用することはできません。
Frame
デフォルトでは、生成されたワークアイテムは、それに該当する入力のワークアイテムからframe
アトリビュートを継承します。
ただし、 Frame が有効な場合、このノードは、このパラメータフィールドで指定されたエクスプレッションから独自のframe
値を生成します。
これらのパラメータを使用することで、ワークアイテムがクックされた時に実行されるコマンドライン実行可能ファイルを設定することができます。
Specify Using
コマンドライン実行可能ファイルの指定方法を決めます。
Custom String
コマンドライン実行可能ファイルをカスタム文字列で定義します。
Delay
コマンドライン実行可能ファイルを遅延時間で定義します。
Command Builder
コマンドライン実行可能ファイルをコマンドライン引数のマルチパラメータで定義します。
キャッシュ化で Command Builder パラメータを使用する時、出力ファイルパスとして指定された引数がワークアイテムの必要な出力として追加されます。 そして、それらのファイルが まだ存在しない 、または、Cache Modeが Write Files に設定されている場合、ワークアイテムは普段通りにクックされ、そのワークアイテムのクックが終了すると、それらのファイルパスが有効になります。
Command
このノード内のワークアイテムのコマンド文字列を決めます。
このパラメータは、 Specify Command Using が Custom String に設定されている場合にのみ利用可能です。
Delay Time
使用する遅延の長さ(秒)を決めます。 このノード内のワークアイテムは、カスタムのコマンドラインを実行するのではなくて、汎用sleep/waitコマンドラインを実行します。 このパラメータは、遅い作業負荷をシミュレーションして残りのネットワークへの影響を確認するのに役立ちます。
例えば、このパラメータを使用することで、ノードが処理を進める前に正しく結果を待機できるかどうかをチェックすることができます。
Base Command
ベースコマンドラインを指定します。 このパラメータには、実行可能ファイルと、マルチパラメータで利用可能な追加機能を必要としない単純な引数を含めてください。 このベースコマンドラインの末尾に Extra Arguments の追加引数が追加されます。
このパラメータは、 Specify Command Using が Command Builder に設定されている場合にのみ利用可能です。
Run Command in System Shell
このトグルを有効にすると、コマンド文字列は、直接実行するのではなく、システムシェルを使用して実行されます。 これによって、パターンマッチングや展開などのシェル言語の機能を使用することができます。
Extra Arguments
Base Command の末尾に足す追加引数の数を指定します。
単一エクスプレッションでコマンドライン文字列を指定する代わりに、この マルチパラメータのコマンドビルダー を使用して実行可能ファイルの引数を構成することができます。
これらの引数は、上流のファイルまたはワークアイテムアトリビュートで駆動させることができます。 これらの引数をコマンド出力としてマークすることもできます。 その場合、それらの引数の値(s)はワークアイテム上に出力ファイルとして追加されます。
この引数データが配列であれば、構成可能なセパレータを使用してその配列値が自動的に文字列に展開されます。
このマルチパラメータは、 Specify Command Using が Command Builder に設定されている場合にのみ利用可能です。
Argument Enabled
このトグルを有効にすると、コマンド文字列に引数が追加されます。 これを無効にすると、引数は無視されます。
Argument Name
-o
や--output
などの引数の名前。
この名前には必要に応じて-
を入れてください。
Argument Source
引数に渡されるデータのソース。
Upstream Output Files
上流の出力ファイルからの値。
Attribute Name
アトリビュート名からの値。
Custom Value
カスタムエクスプレッションからの値。
None
引数が値を持たず、引数名のみがコマンド文字列に含まれます。
Input File Tag
ファイルをフィルタリングする際に使用するタグを決めます。
このパラメータは、 Argument Source が Upstream Output Files に設定されている場合にのみ利用可能です。
Attribute Name
引数データを設定する際に使用するアトリビュートの名前を指定します。 PDGは配列長に関係なく配列アトリビュートを読み込んで文字列に変換することができるので、これは配列データを照会する時に役立ちます。
このパラメータは、 Argument Source が Attribute Name に設定されている場合にのみ利用可能です。
Argument Value
ワークアイテム毎に評価される引数値を決めます。
このパラメータは、 Argument Source が Custom Value に設定されている場合にのみ利用可能です。
Collapse Arrays To
ファイルまたはアトリビュート値の配列をコマンドラインに追加する時に、その配列の制御方法を決めます。 配列は、スペース区切りの値のリスト、カンマ区切りの値のリスト、独自セパレータで区切った値のリストとして追加することができます。 別の方法として、引数全体を配列内のエントリー毎にコピーすることができます。
例えば、["example", "example1", "example2"]
のエントリーを含んだ入力データ配列と“–input”の引数名を渡すと、以下の展開が行なわれます:
Space-Separated String
executable --input "example" "example1" "example2"
Comma-Separated String
executable --input "example","example1","example2"
String with Custom Separator
#
に設定した場合。
Multiple Arguments
executable --input "example" --input "example1" --input "example2"
このパラメータは、 Argument Source が Custom Value に設定 されていない 時にのみ利用可能です。
Array Separator
このパラメータは、 Collapse Arrays To が String with Custom Separator に設定されていて、そのフィールドが Collapse Arrays To ドロップダウンメニューの 右側 にある時にのみ利用可能です。
配列内のエントリー間で使用するセパレータを指定します。
Attach Argument as Output File
有効にすると、この引数からの値(s)がワークアイテム上に出力ファイルとして追加されます。 ファイルがExpected Outputsとして追加されるので、それらのファイルが Cache Mode パラメータで動作します。 このファイルは、ディスク上に存在していると想定して、ワークアイテムがクックされた後に通常の出力に変換されます。
Take Ownership of File
PDGワークアイテムがファイルを owned としてマークします。 PDGクックによって生成されたファイルであることを示したい場合には、これを使用してください。
Warning
owned としてマークされた Output Files は、 Delete All File Outputs From Disk などのメニューアクションで削除されます。
Custom File Tag
このパラメータを有効にすると、このノードが出力ファイルをワークアイテムに添付する際に使用するファイルタグを指定することができます。 無効にすると、PDGは、上流のワークアイテムからコピーされたファイルに関連付けられている既存のタグを使用するか、または、ファイルが存在しなければファイルの拡張子から自動的にタグを取得します。
以下のパラメータを使用することで、必要な出力ファイルをワークアイテムに割り当てることができます。これによって、PDGはワークアイテムがクックされた時にそのワークアイテムが生成すべき出力を知ることができます。
Expected Outputs From
必要な出力ファイルの指定方法を決めます。
Attribute Name
Expected Outputs From が Attribute Name に設定されている時、このパラメータには、ファイルパス(s)を含んだアトリビュートの名前を指定します。
Custom File Tag
このパラメータを有効にすると、独自のタグ値がすべての出力ファイルに割り当てられます。 無効にすると、PDGはファイルに設定されている既存のタグを使用するか、または、タグが存在しなければファイルの拡張子から自動的にタグを取得します。
Files
Expected Outputs From が File List に設定されている時、このパラメータはファイルリストのエントリーの数を決めます。
Output File
ファイルのパス。
Schedulers ¶
TOP Scheduler Override
このパラメータは、このノードのTOPスケジューラを上書きします。
Schedule When
有効にすると、このパラメータを使用して、このノードのどのワークアイテムをスケジュールに組むのかを決めるエクスプレッションを指定することができます。 そのエクスプレッションが指定されたワークアイテムに対して0を返すと、そのワークアイテムはスケジューラに組まれずに、即座にクック済みとしてマークされます。 そのエクスプレッションが0以外の値を返すと、そのワークアイテムは従来どおりにスケジュールに組まれます。
Work Item Label
このノードがワークアイテムにどのようにラベルを付けるのかを決めます。 このパラメータによって、固有でないラベル文字列をワークアイテムに割り当てることができ、そのラベルを使用してアトリビュートパネル、タスクバー、スケジューラジョブ名のワークアイテムを区別することができます。
Use Default Label
このノード内のワークアイテムは、TOPネットワークからデフォルトのラベルを使用します。 デフォルトが設定されていない場合は、それらのワークアイテムにはラベルは付きません。
Inherit From Upstream Item
ワークアイテムは親ワークアイテムのラベルを継承します。
Custom Expression
ワークアイテム毎に評価される Label Expression カスタムエクスプレッションをワークアイテムのラベルに設定します。
Node Defines Label
ワークアイテムのラベルをこのノードの内部ロジックで定義します。
Label Expression
有効にすると、このパラメータを使用して、このノードで作成されたワークアイテムに独自のラベルを指定することができます。
このパラメータには、ワークアイテムアトリビュートの参照またはビルトインのプロパティを含めたエクスプレッションを使用することができます。
例えば、$OS: @pdg_frame
は、フレーム値に基づいて各ワークアイテムのラベルを設定します。
Work Item Priority
このパラメータは、現行スケジューラがこのノード内のワークアイテムの優先度を設定する方法を決めます。
Inherit From Upstream Item
ワークアイテムは、親ワークアイテムの優先度を継承します。ワークアイテムに親ワークアイテムがなければ、その優先度は0に設定されます。
Custom Expression
ワークアイテムの優先度は、 Priority Expression の値に設定されます。
Node Defines Priority
ワークアイテムの優先度は、このノード自身の内部優先度計算に基づいて設定されます。
このオプションは、 Python Processor TOP, ROP Fetch TOP, ROP Output TOPのノードでのみ利用可能です。 これらのノードは、各自のノードロジックで実装された優先度設定スキームを定義しています。
Priority Expression
このパラメータには、ワークアイテムの優先度を設定するためのエクスプレッションを指定します。 このエクスプレッションは、ノード内のワークアイム毎に評価されます。
このパラメータは、 Work Item Priority が Custom Expression に設定されている場合にのみ利用可能です。
Files ¶
File Dependencies
このノード内の最初のワークアイテムが実行される前にPDG作業ディレクトリにコピーしておきたいファイルのリスト。 これを使用することで、デジタルアセットやカスタムスクリプトなどのサポートファイルをワークアイテムジョブで利用可能にすることができます。
指定可能なパスは、絶対パスまたはHOUDINI_PATHを基準とした相対パスです。
Examples ¶
GenericGenerator Example for Generic Generator TOP node
このサンプルでは、Generic Generatorノードを使用して、セットアップを試行したり、独自のコマンドラインを実行する方法を説明しています。
See also |