Inheritence |
|
このクラスには、PDG内のワークアイテムに関する情報にアクセスする方法が備わっています。 pdg.Graph.workItemByNameメソッドを使えば名前によってワークアイテムを照会することができ、 pdg.Graph.workItemByIdメソッドを使えばIDによってワークアイテムを照会することができます。
また、pdg.Nodeオブジェクトにもそのノードが所有しているワークアイテムにアクセスする方法が備わっています。
メソッド
addAttrib(name, type:
pdg.attribType)
→ pdg.AttributeFile or pdg.AttributeFloat or pdg.AttributeInt or pdg.AttributePyObject or pdg.AttributeString
指定した名前とタイプのアトリビュートを追加します。 同じ名前のアトリビュートが既に存在し、且つ、同じタイプだった場合、その既存アトリビュートが返されます。 同じ名前で異なるタイプのアトリビュートが存在した場合、例外が引き起こされます。
addEnvironmentVar(str)
ワークアイテムの環境に環境変数を追加します。
このメソッドは廃止されました。
代わりにpdg.WorkItem.addAttribを使用してアトリビュートを追加し、そのアトリビュートにpdg.attribFlag.EnvExport
フラグを設定してください。
addEventHandler(handler, filter:
pdg.EventType, pass_handler=False)
→ pdg.EventHandler
ワークアイテムに、受信するイベントのタイプの値を持ったイベントハンドラーを追加します。
このhandler
には、pdg.Eventタイプの引数を受け取るCallableを指定してください。
pass_handler
がTrueの場合、このハンドラー自体がこの関数の1番目の引数に渡されます。
Falseの場合、イベントオブジェクトのみがこの関数に渡されます。
addEventHandler(handle, event_types:
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がディスクから出力ファイルを削除する時に使用されます。
addResultData(result, tag, checksum, own=True)
指定したファイルタグとchecksum
値を持つワークアイテムにResultファイルを追加します。
オプションのown
パラメータは、ワークアイテムがそのファイルを所有するかどうかを示し、PDGがディスクから出力ファイルを削除する時に使用されます。
attrib(name)
→ pdg.AttributeFile or pdg.AttributeFloat or pdg.AttributeInt or pdg.AttributePyObject or pdg.AttributeString
指定した名前のワークアイテムアトリビュートを返します。
そのようなアトリビュートが存在しなければNone
を返します。
返されるアトリビュートは、pdg.attribTypeに載っているサポートされているアトリビュートタイプのどれかです。
これは、work_item.attrib[name]
と記述することもできます。
attrib(name, type)
→ pdg.AttributeFile or pdg.AttributeFloat or pdg.AttributeInt or pdg.AttributePyObject or pdg.AttributeString
指定した名前とタイプのワークアイテムアトリビュートを返します。
そのようなアトリビュートが存在しなければNone
を返します。
attribMatch(pattern)
→ list
of str
指定したpdg.AttributePatternインスタンスに合致したワークアイテムからアトリビュート名のリストを返します。
attribNames()
→ list
of str
ワークアイテムに現在保存されているアトリビュート名のリストを返します。
attribNames(type)
→ list
of str
指定したタイプのワークアイテムに現在保存されているアトリビュート名のリストを返します。
attribArray(name)
→ list
of int
, float
, str
or pdg.File
アトリビュートに保存されている配列を返します。
attribValue(name, index=0)
→ int
, float
, str
or pdg.File
アトリビュートの指定したインデックスでの値を返します。
これは、work_item[name][index]
と記述することもできます。
attribValues()
→ dict
of list
of int
, float
, and str
ワークアイテム上のすべてのアトリビュート名とその値のマップを返します。
attribValues(type)
→ dict
of list
of int
, float
, or str
ワークアイテム上の指定したpdg.attribTypeのすべてのアトリビュート名とその値のマップを返します。
attribType(name)
→ pdg.attribType
指定した名前のアトリビュートのタイプを返します。
その名前のアトリビュートが存在しなければpdg.attribType.Undefined
を返します。
clearAttribs()
ワークアイテム上のすべてのアトリビュートをクリアします。
clearAttribs(type)
ワークアイテム上の指定したタイプのすべてのアトリビュートをクリアします。
clearEnvironment()
ワークアイテムの環境をクリアして、親ワークアイテムから環境変数を継承しないようにします。
このメソッドは廃止されました。
代わりにpdg.attribFlag.EnvExport
フラグが設定されたアトリビュートを削除してください。
clearResultData()
ワークアイテム上のResultファイルすべてをクリアします。
cookWarning(message)
このワークアイテムを所有しているノードに警告メッセージを追加します。
dirty(delete, remove_outputs)
ワークアイテムをDirty(変更あり)にします。delete
をTrue
に設定すると、そのワークアイテムが削除されます。
remove_outputs
がTrue
の場合、このワークアイテムで生成されたディスク上のファイル結果も削除されます。
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
指定したインデックスでの整数アトリビュート値を返します。
lockAttributes()
→ pdg.LockAttributesBlock
コンテキストマネージャを使ってこのワークアイテムのアトリビュートをロックします。 コンテキストマネージャが使用されている間は、ワークアイテム上のアトリビュートを安全に変更することができます。
Note
このメソッドは、onGenerate
やonPartition
などのPDGノードコールバック内からコールしないでください。
このノードは、既にそのコールバックが安全にすべてのワークアイテムにアクセスできることを保証しています。
例:
with item.lockAttributes(): item.setIntAttrib("example", 10)
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オブジェクトで返されます。
serializeData()
→ str
ワークアイテムのデータを文字列にシリアライズ化します。
serializeDataToFile(filepath)
ワークアイテムのデータをファイルにシリアライズ化します。
setAttribFlag(name, flag, set)
指定したアトリビュートにpdg.attribFlagを設定またはクリアします。
setCommand(command)
ワークアイテムのコマンド値に、指定したコマンド文字列を設定します。
setFileAttrib(name, value, index=0)
指定したインデックスでのファイルアトリビュート値を設定します。 このアトリビュートが存在しなかった場合は作成されます。
setFileAttrib(name, array)
ファイルアトリビュート配列を設定します。 このアトリビュートが存在しなかった場合は作成されます。
setFloatAttrib(name, value, index=0)
指定したインデックスでの浮動小数点アトリビュート値を設定します。 このアトリビュートが存在しなかった場合は作成されます。
setFloatAttrib(name, array)
浮動小数点アトリビュート配列を設定します。 このアトリビュートが存在しなかった場合は作成されます。
setFrame(frame, step=1.0)
ワークアイテムにフレーム、オプションでフレームステップサイズを設定します。
setIntAttrib(name, value, index=0)
指定したインデックスでの整数アトリビュート値を設定します。 このアトリビュートが存在しなかった場合は作成されます。
setIntAttrib(name, array)
整数アトリビュート配列を設定します。 このアトリビュートが存在しなかった場合は作成されます。
setIsPostCook(is_postcook)
このワークアイテムがクックを終了した後にonPostCookTask
コールバックを実行するどうかを設定します。
このコールバックは、このワークアイテムを所有しているノードでonPostCookTask
実装が定義されている場合にのみ実行されます。
setPyObjectAttrib(name, value)
Pythonオブジェクトアトリビュート値を設定します。 このアトリビュートは、そのアトリビュート自体が存続期間中に存在できることを保証するために参照カウントを増分します。
setStringAttrib(name, value, index=0)
指定したインデックスでの文字列アトリビュート値を設定します。 このアトリビュートが存在しなかった場合は作成されます。
setStringAttrib(name, array)
文字列アトリビュート配列を設定します。 このアトリビュートが存在しなかった場合は作成されます。
stringAttribute(name)
→ str
ワークアイテム上の文字列アトリビュート値を照会します。
ここには、foo
のようなアトリビュート名、または、foo.x
のようにアトリビュート名とコンポーネントの接尾辞を指定することができます。
このメソッドは廃止されました。
代わりにitem.attrib(name)
を使ってアトリビュートを検索してattrib.asString()
をコールしてください。
stringAttribArray(name)
→ list
of str
文字列アトリビュート配列を返します。
stringAttribValue(name, index=0)
→ str
指定したインデックスでの文字列アトリビュート値を返します。
updateResultData(index, file, tag, checksum, own)
指定したインデックスのResult Dataを更新します。
baseName
: str
Property
ワークアイテムのベース名。これは必ずしも固有であるとは限りません。
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
ワークアイテムの環境変数を変数名と値でマップした辞書。
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
に設定されます。
id
: int
Property
ワークアイテムのID。これは、そのワークアイテムを含んだpdg.GraphContext内で固有です。
index
: index
Property
ワークアイテムのソート/順番のインデックス。
inputResultData
: list
of pdg.File
Property
このワークアイテムの入力結果のリスト。このワークアイテムが依存している入力結果すべてがリストに入ります。
isControl
: bool
Property
このワークアイテムが内部コントロールアイテムの場合はTrue
に設定され、そうでない場合はFalse
に設定されます。
isInProcess
: bool
Property
このワークアイテムがアクティブスケジューラを使用して子プロセスとしてクックされているのではなくIn-ProcessでクックされていればTrue
に設定されます。
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
に設定されます。
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オブジェクトが格納されています。
staticAncestors
: list
of pdg.WorkItem
Property
ワークアイテムの静的な親アイテム。 これが動的なアイテムの場合は、その親アイテムは一番近い上流の静的なワークアイテムです。 これが静的なアイテムの場合は、その親アイテムはこのワークアイテム自身です。