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

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

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

Adds an error message to the work item’s internal, in-process log. If the work item is running in a Python Script or Python Processor and fail_tasks is True, execution of the work item will also be interrupted.

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

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

ワークアイテムに必要なResultファイルを、指定したファイルタグを付けて追加します。 resultは、ワークアイテムがクックした時に生成するファイルの文字列パスです。 オプションのownパラメータは、ワークアイテムがそのファイルを所有するかどうかを示します。 PDGは、ディスクから出力ファイルを削除する時にこのパラメータを使用します。

Adds a message to the work item’s internal, in-process log.

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

Adds a log message of the specified pdg.workItemLogType to the work item’s internal, in process-log. This is the generic version of the specialized log methods, like addError or addMessage.

Adds a warning message to the work item’s internal, in-process log.

指定した名前のワークアイテムアトリビュートを返します。 そのようなアトリビュートが存在しなければNoneを返します。 返されるアトリビュートは、pdg.attribTypeに載っているサポートされているアトリビュートタイプのどれかです。 これは、work_item.attrib[name]と記述することもできます。

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

ワークアイテムのアトリビュート値に基づいて計算されたハッシュ値を返します。 これは、クック間のワークアイテムの識別に役立ちます。

The include_internal argument determines whether or not the hashing operation should include internal attributes defined by PDG itself, like work item input/output files or the the command string.

When the include_unowned argument is False the hashing operation will only consider attributes that were modified or added by the node that owns the work item. Otherwise, all attributes are considered.

When the only_static argument is True the hashing operation will only consider attributes created when the work item was generated. Any attribute additions or modifications made while the work item was scheduled or cooked are not included in the hash.

指定したpdg.AttributePatternインスタンスに合致したワークアイテムからアトリビュート名のリストを返します。

ワークアイテムに現在保存されているアトリビュート名のリストを返します。

アトリビュートの指定したインデックスでの値を返します。 これは、work_item[name][index]と記述することもできます。

ワークアイテム上のすべてのアトリビュート名とその値のマップを返します。

指定した名前のアトリビュートのタイプを返します。 その名前のアトリビュートが存在しなければpdg.attribType.Undefinedを返します。

Cancels the cook of the work item, if it has already been scheduled by a scheduler. If the item has not been scheduled yet, it will eventually canceled when it gets processed by the scheduler associated with it.

ワークアイテム上のすべてのアトリビュートをクリアします。

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

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

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

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

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

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

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

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

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

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

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

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

指定したタグのResultファイルパスを返します。

ワークアイテムが指定したアトリビュートを持っていればTrueを返します。

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

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

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

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

Loads a work item from the specified JSON file path.

Loads a work item from the specified JSON string data

コンテキストマネージャを使ってこのワークアイテムのアトリビュートをロックします。 コンテキストマネージャが使用されている間は、ワークアイテム上のアトリビュートを安全に変更することができます。

例:

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

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

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

例:

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

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

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

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

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

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

指定したタグのResult Dataエントリーを返します。 この結果は、pdg.Fileオブジェクトで返されます。

Saves the work item to a JSON file and returns True on success.

Saves the work item to JSON and returns it as a string.

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

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

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

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

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

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

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

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

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

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

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

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

Sets the descriptive label for the work item. The label string does not have to be unique, and can contain spaces or other special characters.

Sets the loop iteration, number and size for the work item. Only safe to call inside of a feedback begin node.

Pythonオブジェクトアトリビュート値を設定します。 このアトリビュートは、そのアトリビュート自体が存続期間中に存在できることを保証するために参照カウントを増分します。

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

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

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

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

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

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

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

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

このワークアイテムがバッチの親と共有されたアトリビュートを持つバッチ内のワークアイテムであれば、時間依存のアトリビュートのリストを返します。

Manually runs file transfer logic for any work item files attributes that have the pdg.attribFlag.Transfer attribute flag set to True. Files are copied using custom file transfer handlers if any have been registered, otherwise the files are copied to the working directory using the default scheduler logic. The function returns True if all files are copied successfully, or False if one or more errors occurred.

If update_cache is True, then any file attributes with the pdg.attribFlag.InputFile will be checked when transfering files. Input file attributes will be added to a table on the containing Node and tracked during future cooks. If an input file is was modified between cooks, then the output cache of this work item will also be invalidated. If update_cache is False then the work item’s cache will not be invalidated, even if the file on disk was updated.

指定したインデックスのResult Dataを更新します。

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

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

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

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

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

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

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

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

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

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

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

ワークアイテムで必要とされる結果のリスト。 このリストは、pdg.Fileオブジェクトで格納されています。

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

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

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

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

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

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

このワークアイテムの入力結果のリスト。このワークアイテムが依存している入力結果すべてがリストに入ります。

このワークアイテムがアクティブスケジューラを使用して子プロセスとしてクックされているのではなく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に設定されます。

Returns the label for the work item. If the item has no label, this property returns the name value instead.

The nested loop depth for the work item, if it is part of a loop block, starting at 0. If the work item is not inside of a loop this property will be set to -1.

The iteration number for the work item, if it is part of a loop block. If the work item is not inside of a loop this property will be set to -1.

The loop number for the work item, if it is part of a loop block. Feedback loop blocks can contain multiple independent groups of work items, each of which will have its own loop number. Work items within the same numbered loop will have unique iteration numbers from 0 to the size of the loop. If the work item is not inside of a loop this property will be set to -1.

The size of the loop that contains the work item, or -1 if the work item is not inside of a loop block.

The raw string data for the work item’s in-process log, which contains any messages add by the calling the pdg.WorkItem.addMessage.

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

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

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

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

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

ワークアイテムのResult Dataのリスト。このリストには、pdg.Fileオブジェクトが格納されています。

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

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

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