詳細は、pdg.WorkItemHolder.addWorkItem()を参照してください。
メソッド ¶
batch
: bool
Property
True
に設定すると、ワークアイテムがバッチとして構築されます。
デフォルトはFalse
です。
batchOffset
: int
Property
batch
がTrue
の時のそのバッチ内のワークアイテムのインデックスオフセット。
batchSize
: int
Property
batch
がTrue
の時のバッチのサイズ。
cloneOutputFiles
: bool
Property
True
に設定すると、新しいワークアイテムはその親ワークアイテムの出力ファイルをクローンします。
デフォルトはFalse
です。
cloneResultData
: bool
Property
このプロパティは廃止されました。代わりにpdg.WorkItemHolder.cloneOutputFilesを使用してください。
cloneTarget
: pdg.WorkItem
Property
データのクローン元となるオプションのクローンターゲット。デフォルトはNone
です。
cookType
: pdg.workItemCookType
Property
ワークアイテムのクックタイプ。
これは、古いinProcess
オプションよりも優先されます。
デフォルトはpdg.workItemCookType.Automaticで、ノードの設定が使用されます。
inProcess
: bool
Property
True
に設定すると、ワークアイテムがプロセス外ではなくプロセス内で評価されるようにマークされます。
デフォルトはFalse
です。
このプロパティは廃止されました。代わりにcookType
を使用してください。
index
: int
Property
ワークアイテムインデックス。これを-1に設定すると、デフォルトは親ワークアイテムのインデックスになります。
デフォルトは-1
です。
isDynamicBatch
: bool
Property
Whether or not the batch is allowed to dynamically add sub items while it cooks.
Only used when batch
is set to True
.
isNoGenerate
: bool
Property
このフラグを設定すると、ワークアイテムは下流のノードで新しいワークアイテムが生成できないようにマークされます。
デフォルトはFalse
です。
isPartialCook
: bool
Property
Whether or not a batch supports cooking from part way through its list of sub items, if some of the items are already cached.
Only used when batch
is set to True
isServiceMode
: bool
Property
このフラグと inProcess フラグの両方をTrueに設定すると、このワークアイテムは、そのワークアイテムのノードに関係付けられているPDGサービスによってクックされます。
name
: str
Property
This option is deprecated, and will have no effect on work item(s) created using this options instance. Instead, use pdg.WorkItem.setLabel to customize the display name of a work item.
parent
: pdg.WorkItem
Property
新しく構築されるワークアイテムの親。
動的ノードに関しては、onGenerate
コールバックに渡された完了した上流ワークアイテム次第で親が変わるため、このオプションを変更することができません。
静的ノードに関しては、上流の静的ワークアイテムのどれかに設定することができます。
parentArray
: list
of pdg.WorkItem
Property
静的バッチを生成する時、そのバッチ内のワークアイテム毎に異なる親ワークアイテムを指定することができます。 これは、ワークアイテムの配列をこのプロパティを使ってホルダーに渡すことで処理されます。 配列サイズが生成されるバッチの数より少ない場合、その配列の最後のエレメントが残りの配列のすべてのバッチの親として再利用されます。
parentArrayOffset
: int
Property
parentArray
を使用した時、このプロパティを使用することで、その配列の開始オフセットを指定することができます。
デフォルトでは、その配列はインデックス0から開始してアクセスされます。
これは、複数のバッチを生成する時にバッチ毎に別々の親配列値を構築する必要がないので便利です。
addWorkItem
をコールする度に別のオフセット値を指定することで、同じ配列を再利用することができます。
preserveType
: bool
Property
True
に設定すると、新しいワークアイテムは、親ワークアイテムのワークアイテムデータタイプの維持を試みます。
デフォルトはFalse
です。
priority
: int
or None
Property
ワークアイテムの優先度。デフォルトはNone
です。
typeName
: str
Property
ワークアイテムを構築する時に使用するワークアイテムデータタイプの名前。 デフォルトは、このノードのデフォルトのワークアイテムタイプ名です。