Inheritence |
|
メソッド
activationMode
: pdg.batchActivation
Property
バッチのアクティベーションモード。これは、バッチアイテムがクックを開始するタイミングを決定します。
batchName
: str
Property
バッチの名前。
batchSize
: int
Property
バッチ内のサブアイテムの数。
batchStart
: int
Property
バッチがキャッシュ化時の部分クックに対応していた場合のそのバッチの開始インデックス。
offset
: int
Property
バッチアイテムの開始オフセット(グローバルインデックス空間)。
Methods from pdg.WorkItem
addAttrib(name, type:
pdg.attribType, overwrite=
pdg.attribOverwrite.Match, error_level=
pdg.attribErrorLevel.Error)
→ pdg.AttributeFile or pdg.AttributeFloat or pdg.AttributeInt or pdg.AttributePyObject or pdg.AttributeString
指定した名前とタイプのアトリビュートを追加します。
オプションのoverwrite
引数にpdg.attribOverwrite列挙型の値を設定することで、ワークアイテムが既にname
と同じアトリビュートを持っていた場合の挙動を制御することができます。
デフォルトでは、同じ名前のアトリビュートが既に存在し、且つ、同じタイプだった場合、その既存アトリビュートが返されます。
同じ名前で異なるタイプのアトリビュートが存在した場合、例外が引き起こされます。
overwrite
にpdg.attribOverwrite.Alwaysを設定すると、既存のアトリビュートが削除され、新しいtype
のアトリビュートに置換されます。
オプションのerror_level
引数を使用することで、PDGハンドルが失敗した場合の挙動を制御することができます。
デフォルトでは、その失敗の原因を示したメッセージを出して例外が引き起こされます。
代わりにpdg.attribErrorLevel.Warn列挙型の値を渡すと、そのエラーメッセージはワークアイテムを所有しているノードに警告として追加されます。
最終的にpdg.attribErrorLevel.Quietを渡すと、すべてのエラーレポートが抑制されます。
error_level
引数にError
以外の値を設定すると、このメソッドは、アトリビュートを追加できなかった時にNone
を返します。
addEnvironmentVar(str)
ワークアイテムの環境に環境変数を追加します。
このメソッドは廃止されました。
代わりにpdg.WorkItem.addAttribを使用してアトリビュートを追加し、そのアトリビュートにpdg.attribFlag.EnvExport
フラグを設定してください。
addError(error_message, fail_task=False)
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.
addEventHandler(handler, filter:
pdg.EventType, pass_handler=False)
→ pdg.EventHandler
ワークアイテムに、受信するイベントのタイプの値を持ったイベントハンドラーを追加します。
このhandler
には、pdg.Eventタイプの引数を受け取るCallableを指定してください。
pass_handler
がTrueの場合、このハンドラー自体がこの関数の1番目の引数に渡されます。
Falseの場合、イベントオブジェクトのみがこの関数に渡されます。
addExpectedResultData(result, tag, own=True)
ワークアイテムに必要なResultファイルを、指定したファイルタグを付けて追加します。
result
は、ワークアイテムがクックした時に生成するファイルの文字列パスです。
オプションのown
パラメータは、ワークアイテムがそのファイルを所有するかどうかを示します。
PDGは、ディスクから出力ファイルを削除する時にこのパラメータを使用します。
addMessage(log_message)
Adds a message to the work item’s internal, in-process log.
addResultData(result, tag="", checksum=0, own=True)
指定したファイルタグとchecksum
値を持つワークアイテムにResultファイルを追加します。
オプションのown
パラメータは、ワークアイテムがそのファイルを所有するかどうかを示します。
PDGは、ディスクから出力ファイルを削除する時にこのパラメータを使用します。
addLog(log_type, message)
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
.
addWarning(warning_message)
Adds a warning message to the work item’s internal, in-process log.
attrib(name)
→ pdg.AttributeFile or pdg.AttributeFloat or pdg.AttributeInt or pdg.AttributePyObject or pdg.AttributeString
指定した名前のワークアイテムアトリビュートを返します。
そのようなアトリビュートが存在しなければNone
を返します。
返されるアトリビュートは、pdg.attribTypeに載っているサポートされているアトリビュートタイプのどれかです。
これは、work_item.attrib[name]
と記述することもできます。
attribArray(name)
→ list
of int
, float
, str
or pdg.File
アトリビュートに保存されている配列を返します。
attribHash(include_internal=True, include_unowned=True, only_static=False)
→ int
ワークアイテムのアトリビュート値に基づいて計算されたハッシュ値を返します。 これは、クック間のワークアイテムの識別に役立ちます。
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.
attribMatch(pattern)
→ list
of str
指定したpdg.AttributePatternインスタンスに合致したワークアイテムからアトリビュート名のリストを返します。
attribNames()
→ list
of str
ワークアイテムに現在保存されているアトリビュート名のリストを返します。
attribValue(name, index=0)
→ int
, float
, str
or pdg.File
アトリビュートの指定したインデックスでの値を返します。
これは、work_item[name][index]
と記述することもできます。
attribValues()
→ dict
of list
of int
, float
, and str
ワークアイテム上のすべてのアトリビュート名とその値のマップを返します。
attribType(name)
→ pdg.attribType
指定した名前のアトリビュートのタイプを返します。
その名前のアトリビュートが存在しなければpdg.attribType.Undefined
を返します。
cancel()
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.
clearAttribs()
ワークアイテム上のすべてのアトリビュートをクリアします。
clearEnvironment()
ワークアイテムの環境をクリアして、親ワークアイテムから環境変数を継承しないようにします。
このメソッドは廃止されました。
代わりにpdg.attribFlag.EnvExport
フラグが設定されたアトリビュートを削除してください。
clearExpectedOutputs()
ワークアイテムから、必要とされる出力ファイルをクリアします。
clearResultData()
ワークアイテム上のResultファイルすべてをクリアします。
cookSubItem(state, duration=0)
ワークアイテムがIn-Processでクックされているバッチサブアイテムであれば、このメソッドを使用することで、そのワークアイテムが完了したことをPDGに伝えることができます。
そうすることで、そのワークアイテムに依存している下流のタスクの処理を開始することができます。
state
引数には、pdg.workItemState列挙型から完了状態のどれかを指定してください。
オプションのduration
引数は、ワークアイテムのクック期間を秒で指定します。
In-Processでクックされていないワークアイテム、または、バッチでクックされていないワークアイテムに対してこのメソッドをコールすると、例外が引き起こされます。
cookWarning(message)
このワークアイテムを所有しているノードに警告メッセージを追加します。
dirty(delete, remove_outputs)
ワークアイテムをDirty(変更あり)にします。delete
をTrue
に設定すると、そのワークアイテムが削除されます。
remove_outputs
がTrue
の場合、このワークアイテムで生成されたディスク上のファイル結果も削除されます。
ワークアイテムは、そのワークアイテムがアクティブに評価されている場合、または、Pythonコードをコールしたノードがそのワークアイテムを所有していない場合には、PythonからそのワークアイテムをDirty(変更あり)にすることはできません。 例えば、Python Processor TOP内の上流のワークアイテムまたはPython Script TOPで評価されているワークアイテムをDirty(変更あり)にしようとするのは無効です。
envLookup(key)
→ int
, float
, or str
ワークアイテムの環境変数の値を返します。
このメソッドは廃止されました。
pdg.WorkItem.attribを使ってアトリビュートを検索し、pdg.attribType.EnvExport
フラグをチェックしてください。
eraseAttrib(name)
指定した名前のアトリビュートを消去します。
fileAttribValue(name, index=0)
→ pdg.File
指定したインデックスでのファイルアトリビュート値を返します。
floatAttribArray(name)
→ list
of float
浮動小数点アトリビュート配列を返します。
floatAttribValue(name, index=0)
→ float
指定したインデックスでの浮動小数点アトリビュート値を返します。
firstResultDataForTag(tag)
→ str
指定したタグのResultファイルパスを返します。
hasAttrib(name)
→ bool
ワークアイテムが指定したアトリビュートを持っていればTrue
を返します。
hasEnvironmentVar(name)
→ bool
ワークアイテムに指定した環境変数が定義されいればTrue
を、そうでないならFalse
を返します。
この関数は廃止されました。
今では環境変数はアトリビュートとして実装されているので、アトリビュートを検索することで環境変数をチェックし、そのアトリビュートにpdg.attribFlag.EnvExport
フラグが設定されているかチェックすることができます。
hasDependency(work_item)
→ bool
このワークアイテムが他のワークアイテムに依存している場合はTrue
を返します。
invalidateCache()
このワークアイテムとその下流の依存関係のファイルキャッシュを無効にします。 これによって、キャッシュファイルがディスク上に存在していたとしても、キャッシュモードがAutomaticに設定されているノード内のワークアイテムが再クックされます。
intAttribArray(name)
→ list
of int
整数アトリビュート配列を返します。
intAttribValue(name, index=0)
→ int
指定したインデックスでの整数アトリビュート値を返します。
loadJSONFile(file_path)
→ pdg.WorkItem
Static method
Loads a work item from the specified JSON file path.
loadJSONString(json_string)
→ pdg.WorkItem
Static method
Loads a work item from the specified JSON string data
lockAttributes()
→ pdg.LockAttributesBlock
コンテキストマネージャを使ってこのワークアイテムのアトリビュートをロックします。 コンテキストマネージャが使用されている間は、ワークアイテム上のアトリビュートを安全に変更することができます。
例:
with item.lockAttributes(): item.setIntAttrib("example", 10)
Note
このメソッドは、onGenerate
やonPartition
などのPDGノードコールバック内から コールしないでください 。
このノードは、既にそのコールバックが安全にすべてのワークアイテムにアクセスできることを保証しています。
loopBegin(int)
→ pdg.WorkItem
指定したループ深さにおけるループ開始親アイテムを返します。このアイテムがループ内に存在しない、または、深さが範囲外の場合はNone
を返します。
makeActive()
→ pdg.ActiveItemBlock
Pythonコンテキストマネージャを使用してパラメータを評価できるようにこのワークアイテムをアクティブにします。
このコンテキストマネージャブロックの存続期間中に評価されるすべてのパラメータは、@attribute
またはpdgattribute
関数値を計算する時にこのワークアイテムを使用します。
例:
with item.makeActive(): val = item.node["parm"].evaluateString()
numericAttribute(str)
→ int
or float
指定したアトリビュート文字列のアトリビュート値を返します。
ここには、foo
のようなアトリビュート名、または、foo.x
やfoo.2
のようにアトリビュート名とコンポーネントの接尾辞を指定することができます。
このメソッドは廃止されました。
代わりにitem.attrib(name)
を使ってアトリビュートを検索してattrib.asString()
をコールしてください。
pyObjectAttribValue(name)
→ object
指定したアトリビュートに保存されているPythonオブジェクトを返します。
removeEventHandler(handler)
ワークアイテムからイベントハンドラーを削除します。
removeAllEventHandlers()
ワークアイテムからすべてのイベントハンドラーを削除します。
renameAttrib(src_name, dst_name, overwrite_existing=False)
→ bool
src_name
のアトリビュート名をdst_name
に変更します。
resultDataForTag(tag)
→ array
of pdg.File
指定したタグのResult Dataエントリーを返します。 この結果は、pdg.Fileオブジェクトで返されます。
saveJSONFile(file_path, pretty_print=False)
→ bool
Saves the work item to a JSON file and returns True
on success.
saveJSONString(pretty_print=False)
→ str
Saves the work item to JSON and returns it as a string.
serializeData()
→ str
ワークアイテムのデータを文字列にシリアライズ化します。
serializeDataToFile(filepath)
ワークアイテムのデータをファイルにシリアライズ化します。
setAttribFlag(name, flag, set)
指定したアトリビュートにpdg.attribFlagを設定またはクリアします。
setCommand(command, shell=False)
ワークアイテムのコマンド値に、指定したコマンド文字列を設定します。
shell
をTrue
に設定することで、可能であればシステムシェルでワークアイテムを実行するようにスケジューラに伝えることができます。
例えば、ワークアイテムがLocal Schedulerを使用して実行されると、そのスケジューラは、ワークアイテムのワーカープロセスをSpawn(生成)する際に
shell=True
引数を渡します。
システムシェルではコマンド文字列が実行されるので、環境変数とそのシェルが対応している構文機能を使用することができます。
しかし、シェル機能に依存させてしまうと、ワークアイテムのコマンド文字列がマルチプラットフォームで動作しなくなってしまうことになります。
setFileAttrib(name, value, index=0, overwrite=
pdg.attribOverwrite.Match)
指定したインデックスでのファイルアトリビュート値を設定します。 このアトリビュートが存在 しなかった 場合は作成されます。
オプションのoverwrite
引数は、異なる型でname
と同じアトリビュートが既に存在した場合の挙動を決めます。
詳細は、pdg.WorkItem.addAttribを参照してください。
setFloatAttrib(name, value, index=0, overwrite=
pdg.attribOverwrite.Match)
指定したインデックスでの浮動小数点アトリビュート値を設定します。 このアトリビュートが存在 しなかった 場合は作成されます。
オプションのoverwrite
引数は、異なる型でname
と同じアトリビュートが既に存在した場合の挙動を決めます。
詳細は、pdg.WorkItem.addAttribを参照してください。
setFrame(frame, step=1.0)
ワークアイテムにフレーム、オプションでフレームステップサイズを設定します。
setIntAttrib(name, value, index=0, overwrite=
pdg.attribOverwrite.Match)
指定したインデックスでの整数アトリビュート値を設定します。 このアトリビュートが存在 しなかった 場合は作成されます。
オプションのoverwrite
引数は、異なる型でname
と同じアトリビュートが既に存在した場合の挙動を決めます。
詳細は、pdg.WorkItem.addAttribを参照してください。
setIsPostCook(is_postcook)
このワークアイテムがクックを終了した後にonPostCookTask
コールバックを実行するどうかを設定します。
このコールバックは、このワークアイテムを所有しているノードでonPostCookTask
実装が定義されている場合にのみ実行されます。
setLabel(label)
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.
setLoopInfo(loop_iteration, loop_number, loop_size)
Sets the loop iteration, number and size for the work item. Only safe to call inside of a feedback begin node.
setPyObjectAttrib(name, value, overwrite=
pdg.attribOverwrite.Match)
Pythonオブジェクトアトリビュート値を設定します。 このアトリビュートは、そのアトリビュート自体が存続期間中に存在できることを保証するために参照カウントを増分します。
オプションのoverwrite
引数は、異なる型でname
と同じアトリビュートが既に存在した場合の挙動を決めます。
詳細は、pdg.WorkItem.addAttribを参照してください。
setStringAttrib(name, value, index=0, overwrite=
pdg.attribOverwrite.Match)
指定したインデックスでの文字列アトリビュート値を設定します。 このアトリビュートが存在 しなかった 場合は作成されます。
オプションのoverwrite
引数は、異なる型でname
と同じアトリビュートが既に存在した場合の挙動を決めます。
詳細は、pdg.WorkItem.addAttribを参照してください。
startSubItem(wait=True)
ワークアイテムがIn-Processでクックされているバッチサブアイテムであれば、このメソッドは、そのサブアイテムをクック状態に更新します。 デフォルトでは、このメソッドはサブアイテムのディペンデンシーもクックされるのを待機します。 これは、バッチがすべての入力アイテムを待機せずに即座に開始されるように構成するのに必要です。
In-Processでクックされていないワークアイテム、または、バッチでクックされていないワークアイテムに対してこのメソッドをコールすると、例外が引き起こされます。
stringAttribute(name)
→ str
ワークアイテム上の文字列アトリビュート値を照会します。
ここには、foo
のようなアトリビュート名、または、foo.x
のようにアトリビュート名とコンポーネントの接尾辞を指定することができます。
このメソッドは廃止されました。
代わりにitem.attrib(name)
を使ってアトリビュートを検索してattrib.asString()
をコールしてください。
stringAttribArray(name)
→ list
of str
文字列アトリビュート配列を返します。
stringAttribValue(name, index=0)
→ str
指定したインデックスでの文字列アトリビュート値を返します。
timeDependentAttribs()
→ list
of str
このワークアイテムがバッチの親と共有されたアトリビュートを持つバッチ内のワークアイテムであれば、時間依存のアトリビュートのリストを返します。
transferFiles(update_cache=True)
→ bool
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.
updateResultData(index, file, tag, checksum, own)
指定したインデックスのResult Dataを更新します。
batchIndex
: int
Property
ワークアイテムがバッチ内のワークアイテムの場合、このプロパティには、そのバッチ内でのそのワークアイテムのインデックスが含まれます。
batchParent
: pdg.BatchWorkItem
Property
このワークアイテムがバッチ内のワークアイテムの場合はそのバッチの親を返します。バッチで ない 場合はNone
を返します。
command
: str
Property
ワークアイテムのコマンド文字列。
cookDuration
: int
Property
ワークアイテムがクックされた際のそのワークアイテムのクック期間を示したパフォーマンス統計情報を返します。
data
: pdg.WorkItemData
Property
ワークアイテムのデータオブジェクト。ここには、そのワークアイテムのアトリビュート値が格納されています。
dependencies
: list
of pdg.WorkItem
Property
このワークアイテムが依存しているワークアイテムのリスト。
dependents
: list
of pdg.WorkItem
Property
このワークアイテムに依存しているワークアイテムのリスト。
dependencyState
: pdg.workItemState
Property
すべての依存関係の中で 最低 にクックされた依存関係状態を返します。
すべての依存関係のクックが成功すると、このプロパティはpdg.workItemState.CookedSuccess
に設定されます。
どれかの依存関係がキャンセルされると、dependencyState
は失敗がない限りはpdg.workItemState.CookedCancel
になりますが、どれが失敗するとpdg.workItemState.CookedFail
になります。
environment
: dict
of int
, float
, and str
Property
ワークアイテムの環境変数を変数名と値でマップした辞書。
executionType
: pdg.workItemExecutionType
Property
ワークアイテムの実行タイプ。 例えば、通常のワークアイテムなのか、または、シミュレーショントラッカーのような長時間実行型のプロセスなのかどうか。
expectedInputResultData
: list
of pdg.File
Property
必要ファイルを含むすべての入力のリスト。これらはpdg.Fileオブジェクトとして格納されています。
expectedResultData
: list
of pdg.File
Property
ワークアイテムで必要とされる結果のリスト。 このリストは、pdg.Fileオブジェクトで格納されています。
frame
: float
Property
ワークアイテムに関係のあるフレーム値。
frameStep
: float
Property
ワークアイテムに関係のあるフレームステップサイズ。
hasFrame
: bool
Property
ワークアイテムにフレームが設定されている場合はTrue
に設定され、そうでない場合はFalse
に設定されます。
hasLabel
: bool
Property
If the work item has a custom label, then this property is set to True
. Otherwise the property will be False
.
id
: int
Property
ワークアイテムのID。これは、そのワークアイテムを含んだpdg.GraphContext内で固有です。
index
: index
Property
ワークアイテムのソート/順番のインデックス。
inputResultData
: list
of pdg.File
Property
このワークアイテムの入力結果のリスト。このワークアイテムが依存している入力結果すべてがリストに入ります。
isInProcess
: bool
Property
このワークアイテムがアクティブスケジューラを使用して子プロセスとしてクックされているのではなくIn-ProcessでクックされていればTrue
に設定されます。
それ以外の場合はFalse
に設定されます。
isNoGenerate
: bool
Property
このワークアイテムが下流のノードで子アイテムを何も生成して いない 場合はTrue
に設定されます。
isOutOfProcess
: bool
Property
このワークアイテムがOut-Of-ProcessでクックされていればTrue
に設定されます。
Note
ワークアイテムがまったくクックされて いない 場合、isInProcess
とisOutOfProcess
のどちらともFalse
が返されます。
例えば、Attribute Create TOPノード内のワークアイテムがクック されていなければ 、どちらとも
False
を返します。
isPartition
: bool
Property
このワークアイテムが静的または動的なパーティションの場合はTrue
に設定されます。
isPostCook
: bool
Property
このワークアイテムが完了としてマークされた後にPostCookフックを実行する場合はTrue
に設定され、そうでない場合はFalse
に設定されます。
isStatic
: bool
Property
ワークアイテムが静的(これが通常のワークアイテム)の場合はTrue
に設定されます。
isSuccessful
: bool
Property
クックに成功したワークアイテムの状態がpdg.workItemState.CookedSuccess
またはpdg.workItemState.CookedCache
の場合にTrue
に設定されます。
isUnsuccessful
: bool
Property
クックに成功しなかったワークアイテムの状態がpdg.workItemState.CookedCancel
またはpdg.workItemState.CookedFail
の場合にTrue
に設定されます。
label
: str
Property
Returns the label for the work item. If the item has no label, this property returns the name
value instead.
loopDepth
: int
Property
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.
loopIteration
: int
Property
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.
loopNumber
: int
Property
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.
loopSize
: int
Property
The size of the loop that contains the work item, or -1 if the work item is not inside of a loop block.
logMessages
: str
Property
The raw string data for the work item’s in-process log, which contains any messages add by the calling the pdg.WorkItem.addMessage.
name
: str
Property
ワークアイテムの固有名。これは、pdg.GraphContext内では固有ではありません。
partitionItems
: list
of pdg.WorkItem
Property
ワークアイテムがパーティションの場合、このリストには、そのパーティションが依存しているワークアイテムが格納されています。 そうでない場合、このリストは空っぽです。
priority
: int
Property
ワークアイテムの優先度。0が最高優先度です。
resultData
: list
of pdg.File
Property
ワークアイテムのResult Dataのリスト。このリストには、pdg.Fileオブジェクトが格納されています。
shouldRunInShell
: bool
Property
ワークアイテムコマンドをスケジューラで実行する際にそれをシステムシェルで実行するかどうか。
現在のところ、これはLocal Schedulerにのみ対応しています。