| 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フラグを設定してください。
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は、ディスクから出力ファイルを削除する時にこのパラメータを使用します。
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]と記述することもできます。
attribMatch(pattern)
→ list
of str
指定したpdg.AttributePatternインスタンスに合致したワークアイテムからアトリビュート名のリストを返します。
attribNames()
→ list
of str
ワークアイテムに現在保存されているアトリビュート名のリストを返します。
attribArray(name)
→ list
of int
, float
, str
or pdg.File
アトリビュートに保存されている配列を返します。
attribHash(include_internal)
→ int
ワークアイテムの情報とデータに基づいて計算されたハッシュ値を返します。 ノード名、インデックス、フレーム、優先度、コマンド、アトリビュートのデータすべてが計算に含まれます。 これは、クック間のワークアイテムの識別に役立ちます。
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を返します。
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
指定したインデックスでの整数アトリビュート値を返します。
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オブジェクトで返されます。
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実装が定義されている場合にのみ実行されます。
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
このワークアイテムがバッチの親と共有されたアトリビュートを持つバッチ内のワークアイテムであれば、時間依存のアトリビュートのリストを返します。
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に設定されます。
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に設定されます。
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にのみ対応しています。