指定した名前とタイプのアトリビュートを追加します。

オプションのoverwrite引数にpdg.attribOverwrite列挙の値を設定することで、オブジェクトに既に同じnameのアトリビュートが存在した場合の挙動を制御することができます。 デフォルトでは、同じ名前で同じタイプのアトリビュートが既に存在した場合、既存のアトリビュートが返されます。 同じ名前で異なるタイプのアトリビュートが既に存在した場合、例外が発生します。 overwrite引数にpdg.attribOverwrite.Alwaysを設定した場合、既存のアトリビュートが削除され、新しいtypeのアトリビュートに置換されます。

オプションのerror_level引数を使用することで、PDGハンドルが失敗した場合の挙動を制御することができます。 デフォルトでは、失敗の原因を示したメッセージを出して例外が発生します。 代わりにpdg.attribErrorLevel.Warn列挙値を渡して、このオブジェクトがワークアイテムだった場合、そのワークアイテムを所有するノードにエラーメッセージが警告として追加されます。 または、pdg.attribErrorLevel.Quiet列挙値を渡すと、すべてのエラー報告が抑止されます。 error_level引数にError以外の値を設定した場合、このメソッドは、アトリビュートを追加できなかった時にNoneを返します。

指定した名前のアトリビュートを返します。そのようなアトリビュートが存在しなければNoneを返します。

このアトリビュートは、pdg.attribTypeに載せているアトリビュートタイプのどれかになります。 このアトリビュートをattrib_owner.attrib[name]として記述することもできます。

アトリビュートに格納されている配列を返します。

すべてのアトリビュート値に基づいて計算されたハッシュ値を返します。 これは、クック間でオブジェクトを区別するのに役立ちます。

include_internal引数は、そのハッシュ処理においてPDG自体(例えば、ワークアイテムの入力/出力ファイル、または、コマンド文字列)で定義されている内部アトリビュートを含めるのかどうかを決めます。

これがワークアイテムで、include_unowned引数がFalseの場合、そのハッシュ処理は、そのワークアイテムを所有しているノードによって修正または追加されたアトリビュートのみを考慮します。 それ以外の場合、すべてのアトリビュートが考慮されます。

これがワークアイテムで、only_static引数がTrueの場合、そのハッシュ処理は、そのワークアイテムが生成された時に作成されたアトリビュートのみを考慮します。 そのワークアイテムがスケジュールに組まれた時やクックされた時に追加/修正されたアトリビュートは、そのハッシュ処理には考慮されません。

指定したpdg.AttributePatternインスタンスにマッチしたアトリビュートの名前のリストを返します。

typeがpdg.attribType.Undefinedに設定されている場合、すべてのアトリビュートの名前のリストを返します。 それ以外の場合、指定したタイプのアトリビュートの名前のリストを返します。

指定したインデックスにおけるアトリビュートの値を返します。 このアトリビュートをattrib_owner[name][index]として記述することもできます。

typeがpdg.attribType.Undefinedに設定されている場合、すべてのアトリビュート名とその値のマップを返します。 それ以外の場合、指定したタイプのすべてのアトリビュート名とその値のマップを返します。

指定した名前のアトリビュートのタイプを返します。 その名前のアトリビュートが存在しなかった場合はpdg.attribType.Undefinedを返します。

すべてのアトリビュートをクリアして削除します。

指定した名前のアトリビュートを消去します。

ファイルアトリビュート配列を返します。

指定したインデックスにおけるファイルアトリビュート値を返します。

浮動小数点アトリビュート配列を返します。

指定したインデックスにおける浮動小数点アトリビュート値を返します。

このオブジェクトが指定した名前のアトリビュートを持っていればTrueを返します。

整数アトリビュート配列を返します。

指定したインデックスにおける整数アトリビュート値を返します。

指定したJSONファイルからアトリビュートデータをこのオブジェクトに読み込みます。 collision_strategy引数には、pdg.attribCollisionStrategyのどれかの列挙値を指定してください。

コンテキストマネージャを使用して、このアトリビュートをロックします。 コンテキストマネージャを使用している間は、他のスレッドがアトリビュートを修正してしまわないか心配することなく、そのアトリビュートを安全に修正することができます。

例:

with attrib_owner.lockAttributes():
    attrib_owner.setIntAttrib("example", 10)

typeがpdg.attribType.Undefinedに設定されている場合、マップ内のアトリビュートの数を返します。 それ以外の場合、指定したタイプのアトリビュートの数を返します。

指定したアトリビュートに格納されているPythonオブジェクトを返します。

src_nameというアトリビュート名をdst_nameに変更します。

このオブジェクトに格納されているアトリビュートデータをJSONとして、指定したファイルパスに保存します。 そのファイルパスが.gzで終わっている場合、そのファイルはGZipを使用して圧縮されます。 それ以外の場合、そのファイルはプレーンテキストのJSONとして保存されます。

指定したアトリビュートに対してpdg.attribFlagを設定またはクリアします。

指定したインデックスにファイルアトリビュート値を設定します。 このアトリビュートが 存在しなかった 場合には作成されます。

オプションのoverwrite引数は、同じnameで異なるタイプのアトリビュートが既に存在した場合の挙動を決めます。 詳細は、pdg.AttributeOwner.addAttribを参照してください。

指定したインデックスに浮動小数点アトリビュート値を設定します。 このアトリビュートが 存在しなかった 場合には作成されます。

オプションのoverwrite引数は、同じnameで異なるタイプのアトリビュートが既に存在した場合の挙動を決めます。 詳細は、pdg.AttributeOwner.addAttribを参照してください。

指定したインデックスに整数アトリビュート値を設定します。 このアトリビュートが 存在しなかった 場合には作成されます。

オプションのoverwrite引数は、同じnameで異なるタイプのアトリビュートが既に存在した場合の挙動を決めます。 詳細は、pdg.AttributeOwner.addAttribを参照してください。

Pythonオブジェクトアトリビュート値を設定します。 このアトリビュートは、そのオブジェクト上の参照カウントを増やして、そのアトリビュート自体が存在している間はそのオブジェクトが存在することを保証します。

オプションのoverwrite引数は、同じnameで異なるタイプのアトリビュートが既に存在した場合の挙動を決めます。 詳細は、pdg.AttributeOwner.addAttribを参照してください。

指定したインデックスに文字列アトリビュート値を設定します。 このアトリビュートが 存在しなかった 場合には作成されます。

オプションのoverwrite引数は、同じnameで異なるタイプのアトリビュートが既に存在した場合の挙動を決めます。 詳細は、pdg.AttributeOwner.addAttribを参照してください。

文字列アトリビュート配列を返します。

指定したインデックスの文字列アトリビュート値を返します。

時間依存のアトリビュートのリストを返します。 このメソッドは、バッチの親の共有アトリビュートを所有しているバッチ内のワークアイテムに対して主に使用します。

エラーメッセージをワークアイテムの内部In-Processログに追加します。 ワークアイテムがPython ScriptまたはPython Processorで実行されていて、且つ、fail_tasksがTrueの場合、そのワークアイテムの実行も中断されます。

timestampがTrueの場合、ログメッセージの頭に現在のタイムスタンプが付きます。

ワークアイテムに、受信するイベントのタイプの値を持ったイベントハンドラーを追加します。 このhandlerには、pdg.Eventタイプの引数を受け取るCallableを指定してください。

pass_handlerがTrueの場合、このハンドラー自体がこの関数の1番目の引数に渡されます。 Falseの場合、イベントオブジェクトのみがこの関数に渡されます。

ワークアイテムに必要な出力ファイルを、指定したファイルタグを付けて追加します。 pathは、ワークアイテムがクックした時に生成するファイルの文字列パスです。

オプションのownパラメータは、ワークアイテムがそのファイルを所有するかどうかを示します。 PDGは、ディスクから出力ファイルを削除する時にこのパラメータを使用します。

Adds a list of expected output files to the work item with the specified file tag. paths is the list of string paths to the file that the work item will produce when it cooks.

The optional own parameter indicates whether the work item owns the file. PDG uses this parm when it deletes output files from disk.

This method is more efficient than calling pdg.WorkItem.addExpectedOutputFile in a loop for large file lists.

メッセージをワークアイテムの内部In-Processログに追加します。

timestampがTrueの場合、ログメッセージの頭に現在のタイムスタンプが付きます。

指定したファイルタグとchecksum値を持つワークアイテムに出力ファイルを追加します。 pathは、ディスク上のファイルの文字列パスです。

オプションのownパラメータは、ワークアイテムがそのファイルを所有するかどうかを示します。 PDGは、ディスクから出力ファイルを削除する時にこのパラメータを使用します。

Adds a list of output file to the work item with the specified file tag. paths is the list of string paths to the file on disk, and checksums is the list of checksum values for each file. If the checksums list is empty, the default value of 0 is used for all files. The tag can be either a single string value, used for all file paths, or a list of string values that map to the correpsonding values in the paths list.

The optional own parameter indicates whether the work item owns the file. PDG uses this parm when it deletes output files from disk.

This method is more efficient than calling pdg.WorkItem.addOutputFile in a loop for large file lists.

指定したpdg.workItemLogTypeのログメッセージをワークアイテムの内部In-Processログに追加します。 これは、addErrorやaddMessageなどの特殊なログメソッドの汎用バージョンです。

警告メッセージをワークアイテムの内部In-Processログに追加します。

timestampがTrueの場合、ログメッセージの頭に現在のタイムスタンプが付きます。

ワークアイテムが既にスケジューラによってスケジュールが組まれている場合、そのワークアイテムのクックをキャンセルします。 ワークアイテムがまだスケジュールに組まれていない場合、そのワークアイテムに関連付けられているスケジューラによって処理される時に最終的にそのクックがキャンセルされます。

ワークアイテムのクックの準備が整っていればTrue、そうでないならFalseを返し、そのワークアイテムの依存関係が失敗すれば例外を投げます。 このメソッドは、バッチの一部であるワークアイテムにのみ有効です。

ワークアイテムから、必要とされる出力ファイルをクリアします。

ワークアイテム上の出力ファイルすべてをクリアします。

ワークアイテムがIn-Processでクックされているバッチサブアイテムであれば、このメソッドを使用することで、そのワークアイテムが完了したことをPDGに伝えることができます。 そうすることで、そのワークアイテムに依存している下流のタスクの処理を開始することができます。 state引数には、pdg.workItemState列挙型から完了状態のどれかを指定してください。 オプションのduration引数は、ワークアイテムのクック期間を秒で指定します。

In-Processでクックされていないワークアイテム、または、バッチでクックされていないワークアイテムに対してこのメソッドをコールすると、例外が引き起こされます。

このワークアイテムを所有しているノードに警告メッセージを追加します。

プロセス外クック中に出力をレポートできるようにするために、ワークアイテムに追加されたアトリビュートと出力を含んだJSONオブジェクトを作成します。 このJSONデータは文字列として返されます。

ワークアイテムをDirty(変更あり)にします。deleteをTrueに設定すると、そのワークアイテムが削除されます。 remove_outputsがTrueの場合、このワークアイテムで生成されたディスク上の出力ファイルも削除されます。

ワークアイテムは、そのワークアイテムがアクティブに評価されている場合、または、Pythonコードをコールしたノードがそのワークアイテムを所有していない場合には、PythonからそのワークアイテムをDirty(変更あり)にすることはできません。 例えば、Python Processor TOP内の上流のワークアイテムまたはPython Script TOPで評価されているワークアイテムをDirty(変更あり)にしようとするのは無効です。

指定したタグを持つ最初の出力のファイルパスを返します。

このワークアイテムが他のワークアイテムに依存している場合はTrueを返します。

指定したタグを持つ入力ファイルのリストを返します。

このワークアイテムとその下流の依存関係のファイルキャッシュを無効にします。 これによって、キャッシュファイルがディスク上に存在していたとしても、キャッシュモードがAutomaticに設定されているノード内のワークアイテムが再クックされます。

ワークアイテムに関連付けられているスケジューラを使用して、任意のファイルパスをローカル化します。

指定したJSONファイルパスからワークアイテムを読み込みます。

指定したJSON文字列データからワークアイテムを読み込みます。

指定したループ深さにおけるループ開始親アイテムを返します。このアイテムがループ内に存在しない、または、深さが範囲外の場合はNoneを返します。

Pythonコンテキストマネージャを使用してパラメータを評価できるようにこのワークアイテムをアクティブにします。 このコンテキストマネージャブロックの存続期間中に評価されるすべてのパラメータは、@attributeまたはpdgattribute関数値を計算する時にこのワークアイテムを使用します。

例:

with item.makeActive():
    val = item.node["parm"].evaluateString()

ワークアイテムのメモリ使用量を照会します。

指定したタグの出力ファイルエントリーを返します。 この出力ファイルはpdg.Fileオブジェクトとして返されます。

Returns the platform-specific command line string for a specific pdg.platform. If no platform is specified, the command for the current platform is returned.

ワークアイテムとその依存関係をDirty(変更あり)にする準備をしますが、グラフにはその操作を適用しません。 代わりに、そのDirty操作は後でグラフに適用できるようにpdg.WorkItemDirtyインスタンスに格納されます。

ワークアイテムからイベントハンドラーを削除します。

ワークアイテムからすべてのイベントハンドラーを削除します。

ワークアイテムのリストをJSONファイルに保存し、成功すればTrueを返します。

このメソッドは、file_path内の中間ディレクトリがまだ存在していない場合、そのディレクトリの作成を試みます。 アクセス権限の問題やドライブがアクセス不可などが原因で中間ディレクトリの作成に失敗すると、このメソッドは即座にFalseを返します。

ワークアイテムのリストをJSONに保存し、それを文字列として返します。

ワークアイテムをJSONファイルに保存し、成功するとTrueを返します。

このメソッドは、file_path内の中間ディレクトリがまだ存在していない場合、そのディレクトリの作成を試みます。 アクセス権限の問題やドライブがアクセス不可などが原因で中間ディレクトリの作成に失敗すると、このメソッドは即座にFalseを返します。

ワークアイテムをJSONに保存し、それを文字列として返します。

ワークアイテムのデータを文字列にシリアライズ化します。

ワークアイテムのデータをファイルにシリアライズ化します。

ワークアイテムのコマンド値に、指定したコマンド文字列を設定します。 shellをTrueに設定することで、可能であればシステムシェルでワークアイテムを実行するようにスケジューラに伝えることができます。 例えば、ワークアイテムがLocal Schedulerを使用して実行されると、そのスケジューラは、ワークアイテムのワーカープロセスをSpawn(生成)する際にshell=True引数を渡します。 システムシェルではコマンド文字列が実行されるので、環境変数とそのシェルが対応している構文機能を使用することができます。 しかし、シェル機能に依存させてしまうと、ワークアイテムのコマンド文字列がマルチプラットフォームで動作しなくなってしまうことになります。

Updates the completion percentage on the work item, and broadcasts an event which allows you to listen for these updates.

The event’s pdg.EventType is WorkItemSetCookPercent.

cook_percent: the new completion percentage of the work item. 0 means not started and 100 means it is complete.

ワークアイテムにカスタムステート文字列を設定します。 この文字列は、ワークアイテムアトリビュートパネル内の通常のステートの後に表示されます。 カスタムステートは、例えばワークアイテムがDirtyまたはクック終了になったことでワークアイテムのクック状態が変わる度にクリアされます。

ワークアイテムにフレーム、オプションでフレームステップサイズを設定します。

このワークアイテムがクックを終了した後にonPostCookTaskコールバックを実行するどうかを設定します。 このコールバックは、このワークアイテムを所有しているノードでonPostCookTask実装が定義されている場合にのみ実行されます。

ワークアイテムに説明的なラベルを設定します。 このラベル文字列は固有である必要がないので、スペースや他の特殊文字を含めることができます。

ワークアイテムにループの反復、回数、サイズを設定します。 これは、Feedback Beginノードの中でのみコールするのが安全です。

Sets the platform-specific command line strings for Linux, Windows and Mac.

ワークアイテムがIn-Processでクックされているバッチサブアイテムであれば、このメソッドは、そのサブアイテムをクック状態に更新します。 デフォルトでは、このメソッドはサブアイテムのディペンデンシーもクックされるのを待機します。 これは、バッチがすべての入力アイテムを待機せずに即座に開始されるように構成するのに必要です。

このメソッドをコールすると、ワークアイテムがクックの準備が整った時にバッチの親に対してpdg.BatchWorkItem.setActiveBatchIndexも自動的にコールされます。

In-Processでクックされていないワークアイテム、または、バッチでクックされていないワークアイテムに対してこのメソッドをコールすると、例外が引き起こされます。

ワークアイテムのクック時間の統計情報を返します。

pdg.attribFlag.TransferアトビリュートフラグがTrueに設定されたワークアイテムファイルアトリビュートに対して手動でファイル転送ロジックを実行します。 カスタムファイル転送ハンドラーが登録されていれば、そのハンドラーを使用してファイルがコピーされ、登録されていなければ、デフォルトスケジューラのロジックを使用してファイルが作業ディレクトリにコピーされます。 この関数は、すべてのファイルのコピーに成功するとTrue、どれかエラーが起きるとFalseを返します。

update_cacheがTrueの場合、ファイル転送時に、pdg.attribFlag.InputFileが設定されたファイルアトリビュートがチェックされます。 入力ファイルアトリビュートは、それを含むNodeのテーブルに追加され、今後のクック中に追跡されます。 クック中に入力ファイルが修正された場合、このワークアイテムの出力キャッシュも無効になります。 update_cacheがFalseの場合、ディスク上のファイルが更新されても、ワークアイテムのキャッシュは無効になりません。

指定したインデックスの出力ファイルを更新します。

ワークアイテムがバッチ内のワークアイテムの場合、このプロパティには、そのバッチ内でのそのワークアイテムのインデックスが含まれます。

このワークアイテムがバッチ内のワークアイテムの場合はそのバッチの親を返します。バッチで ない 場合はNoneを返します。

ワークアイテムのコマンド文字列。

ワークアイテムが関連付けられているグラフコンテキスト。

ワークアイテムのクックタイプ。 これは、ワークアイテムがIn-ProcessまたはOut-of-Processのどちらで実行されているかを判断します。

ワークアイテムがクックされた際のそのワークアイテムのクック期間を示したパフォーマンス統計情報を返します。

The cook progress of the work item as a percentage, which is displayed on the work item attribute panel.

It it is 0, it means it has not started. If it is 100, it means it is complete.

Set using pdg.WorkItem.setCookPercent. If it has not been set, it is -1.

pdg.WorkItem.setCustomStateを使用して設定されたワークアイテムのカスタムステート。

ワークアイテムのデータオブジェクト。ここには、そのワークアイテムのアトリビュート値が格納されています。

このワークアイテムが依存しているワークアイテムのリスト。

このワークアイテムに依存しているワークアイテムのリスト。

すべての依存関係の中で 最低 にクックされた依存関係状態を返します。 すべての依存関係のクックが成功すると、このプロパティはpdg.workItemState.CookedSuccessに設定されます。 どれかの依存関係がキャンセルされると、dependencyStateは失敗がない限りはpdg.workItemState.CookedCancelになりますが、どれが失敗するとpdg.workItemState.CookedFailになります。

ワークアイテムの環境変数を変数名と値でマップした辞書。

ワークアイテムの実行タイプ。 例えば、通常のワークアイテムなのか、または、シミュレーショントラッカーのような長時間実行型のプロセスなのかどうか。

必要ファイルを含むすべての入力のリスト。これらはpdg.Fileオブジェクトとして格納されています。

ワークアイテムが必要とする出力ファイルのリスト。 これらのファイルがpdg.Fileオブジェクトとして格納されます。

ワークアイテムに関係のあるフレーム値。

ワークアイテムに関係のあるフレームステップサイズ。

ワークアイテムが関連付けられているグラフ。

If the work item has a command set, then this property is set to True. Otherwise the property will be False.

If the work item has a cook progress percent, then this property is set to True. Otherwise the property will be False.

ワークアイテムにカスタムステートがあれば、このプロパティはTrueに設定されます。 なければ、このプロパティはFalseになります。

ワークアイテムにフレームが設定されている場合はTrueに設定され、そうでない場合はFalseに設定されます。

ワークアイテムの内部ログバッファに最低でも1つの警告メッセージがあれば、このプロパティはTrueに設定されます。 なければ、このプロパティはFalseになります。

ワークアイテムにカスタムラベルがあれば、このプロパティはTrueに設定されます。 なければ、このプロパティはFalseになります。

If the work item has a platform-specific command set, then this property is set to True. Otherwise the property will be False.

ワークアイテムのID。これは、そのワークアイテムを含んだpdg.GraphContext内で固有です。

ワークアイテムのソート/順番のインデックス。

このワークアイテムの入力ファイルのリスト。このワークアイテムのすべての依存関係から収集された出力ファイルがリストに入ります。

ワークアイテムがpdg.BatchWorkItemなら、このプロパティはTrueに設定されます。 そうでないなら、Falseになります。

ワークアイテムがクック状態ならTrue、そうでないならFalseに設定されます。

ワークアイテムがフリーズされている場合(ロックされたノード内にワークアイテムがある場合)、Trueに設定されます。

このワークアイテムがアクティブスケジューラを使用して子プロセスとしてクックされているのではなくIn-ProcessでクックされていればTrueに設定されます。 それ以外の場合はFalseに設定されます。

このワークアイテムが下流のノードで子アイテムを何も生成して いない 場合はTrueに設定されます。

このワークアイテムがOut-Of-ProcessでクックされていればTrueに設定されます。

このワークアイテムが静的または動的なパーティションの場合はTrueに設定されます。

このワークアイテムが完了としてマークされた後にPostCookフックを実行する場合はTrueに設定され、そうでない場合はFalseに設定されます。

ワークアイテムが静的(これが通常のワークアイテム)の場合はTrueに設定されます。

クックに成功したワークアイテムの状態がpdg.workItemState.CookedSuccessまたはpdg.workItemState.CookedCacheの場合にTrueに設定されます。

クックに成功しなかったワークアイテムの状態がpdg.workItemState.CookedCancelまたはpdg.workItemState.CookedFailの場合にTrueに設定されます。

ワークアイテムのラベルを返します。 ワークアイテムにラベルがなければ、代わりにこのプロパティはname値を返します。

ワークアイテムがループブロックの一部の場合、そのワークアイテムの入れ子化されたループの深さ。 これは0から始まります。 ワークアイテムがループの中にない場合、このプロパティは-1に設定されます。

ワークアイテムがループブロックの一部の場合、ワークアイテムの反復回数。 ワークアイテムがループの中にない場合、このプロパティは-1に設定されます。

The ID of the work item that should be used to lock service clients for a loop work item. If this work item is not inside a service-based feedback loop this property will be set to -1.

ワークアイテムがループブロックの一部の場合、ワークアイテムのループ番号。 フィードバックループブロックには、独立した複数のワークアイテムグループを含めることができ、各グループが自身のループ番号を持ちます。 同じ番号のループ内のワークアイテムは、0からループサイズまでの固有の反復回数を持ちます。 ワークアイテムがループの中にない場合、このプロパティは-1に設定されます。

ワークアイテムを含んだループのサイズ。ワークアイテムがループブロックの中にない場合は-1です。

ワークアイテムのIn-ProcessログのRaw文字列データ。 このデータには、pdg.WorkItem.addMessageのコールで追加されたメッセージが含まれています。

ワークアイテムの固有名。これは、pdg.GraphContext内では固有ではありません。

このワークアイテムを所有しているノード。

ワークアイテムの出力ファイルのリスト。

このワークアイテムを生成した上流のワークアイテム。

ワークアイテムがパーティションの場合、このリストには、そのパーティションが依存しているワークアイテムが格納されています。 そうでない場合、このリストは空っぽです。

ワークアイテムの優先度。0が最高優先度です。

ワークアイテムコマンドをスケジューラで実行する際にそれをシステムシェルで実行するかどうか。 現在のところ、これはLocal Schedulerにのみ対応しています。

ワークアイテムの現行状態。

このワークアイテムを所有しているノードに割り当てられているスケジューラに関連付けられている一時ファイルディレクトリ。

ワークアイテムを構築したタイプオブジェクト。