Inheritance |
|
pdg.WorkItemOptionsオブジェクトまたはキー/値の引数をaddWorkItem
メソッドに渡して新しいPDGワークアイテムを構築するためのコンテナオブジェクト。
メソッド ¶
addWorkItem(options=None, **kwargs)
→ pdg.WorkItem
新しいワークアイテムを構築して、それをホルダーに追加します。 この関数には、pdg.WorkItemOptionsオブジェクト、または、ワークアイテムオプションオブジェクトで対応している値に合致したキーワード引数のどちらかを渡すことができます。
例:
# キーワード引数の使い方 item_holder.addWorkItem(index=5, priority=3) # オプションオブジェクトの使い方 options = pdg.WorkItemOptions() options.index = 10 options.priority = 4 options.cloneResultData = True item_holder.addWorkItem(options) # オーバーライド item_holder.addWorkItem(options, batch=True, batchSize=4)
addWorkItemArrayFromJSONFile(file_path, parent=None, strategy=pdg.attribCollisionStrategy.Replace, preserve_type=False, preserve_index=True, add_attributes=True)
→ list
of pdg.WorkItem
保存されたワークアイテムの配列が含まれているfile_path
の.json
ファイルからワークアイテムを追加します。
parent
がNone
でない場合、ワークアイテムは、指定されたワークアイテムの依存関係として追加されます。
このワークアイテムは、ワークアイテム生成中に利用可能な上流ワークアイテムの1つにしてください。
strategy
は、JSONデータ内の親ワークアイテムとワークアイテムに同じ名前のアトリビュートが含まれていた場合の干渉の解決方法を決めます。
デフォルトでは、JSONデータ内のアトリビュートは、親ワークアイテムから継承されたアトリビュートを置換します。
preserve_type
がTrue
の場合、ワークアイテムはシリアライズ化されたJSONデータ内のデータタイプと同じカスタムデータタイプでワークアイテムが作成されます。
False
の場合、ワークアイテムはノードのデフォルトデータタイプを使用します。
preserve_index
がTrue
の場合、ワークアイテムインデックスにはJSONから読み込まれた値が設定されます。
False
の場合、ワークアイテムはparent
ワークアイテムからインデックスを継承します。
add_attributes
がTrue
の場合、元のワークアイテムの名前と状態がアトリビュートとして新規ワークアイテムに追加されます。
addWorkItemArrayFromJSONString(json_data, parent=None, strategy=pdg.attribCollisionStrategy.Replace, preserve_type=False, preserve_index=True, add_attributes=True)
→ list
of pdg.WorkItem
保存されたワークアイテムの配列が含まれているjson_data
からワークアイテムを追加します。
parent
がNone
でない場合、ワークアイテムは、指定されたワークアイテムの依存関係として追加されます。
このワークアイテムは、ワークアイテム生成中に利用可能な上流ワークアイテムの1つにしてください。
strategy
は、JSONデータ内の親ワークアイテムとワークアイテムに同じ名前のアトリビュートが含まれていた場合の干渉の解決方法を決めます。
デフォルトでは、JSONデータ内のアトリビュートは、親ワークアイテムから継承されたアトリビュートを置換します。
preserve_type
がTrue
の場合、ワークアイテムはシリアライズ化されたJSONデータ内のデータタイプと同じカスタムデータタイプでワークアイテムが作成されます。
False
の場合、ワークアイテムはノードのデフォルトデータタイプを使用します。
preserve_index
がTrue
の場合、ワークアイテムインデックスにはJSONから読み込まれた値が設定されます。
False
の場合、ワークアイテムはparent
ワークアイテムからインデックスを継承します。
add_attributes
がTrue
の場合、元のワークアイテムの名前と状態がアトリビュートとして新規ワークアイテムに追加されます。
addWorkItemFromJSON(json_string, parent=None, strategy=pdg.attribCollisionStrategy.Replace, preserve_type=False, preserve_index=True, add_attributes=True)
→ pdg.WorkItem
このメソッドは廃止されました。代わりに、addWorkItemFromJSONFromString
またはaddWorkItemFromJSONFile
を使用してください。
addWorkItemFromJSONFile(file_path, parent=None, strategy=pdg.attribCollisionStrategy.Replace, preserve_type=False, preserve_index=True, add_attributes=True)
→ pdg.WorkItem
指定したファイルパスに保存されているワークアイテムJSONデータに基づいて、新しいワークアイテムをホルダーに追加します。
parent
がNone
でない場合、ワークアイテムは、指定されたワークアイテムの依存関係として追加されます。
このワークアイテムは、ワークアイテム生成中に利用可能な上流ワークアイテムの1つにしてください。
strategy
は、JSONデータ内の親ワークアイテムとワークアイテムに同じ名前のアトリビュートが含まれていた場合の干渉の解決方法を決めます。
デフォルトでは、JSONデータ内のアトリビュートは、親ワークアイテムから継承されたアトリビュートを置換します。
preserve_type
がTrue
の場合、ワークアイテムはシリアライズ化されたJSONデータ内のデータタイプと同じカスタムデータタイプでワークアイテムが作成されます。
False
の場合、ワークアイテムはノードのデフォルトデータタイプを使用します。
preserve_index
がTrue
の場合、ワークアイテムインデックスにはJSONから読み込まれた値が設定されます。
False
の場合、ワークアイテムはparent
ワークアイテムからインデックスを継承します。
add_attributes
がTrue
の場合、元のワークアイテムの名前と状態がアトリビュートとして新規ワークアイテムに追加されます。
addWorkItemFromJSONString(json_data, parent=None, strategy=pdg.attribCollisionStrategy.Replace, preserve_type=False, preserve_index=True, add_attributes=True)
→ pdg.WorkItem
ワークアイテムJSONデータに基づいて、新しいワークアイテムをホルダーに追加します。
parent
がNone
でない場合、ワークアイテムは、指定されたワークアイテムの依存関係として追加されます。
このワークアイテムは、ワークアイテム生成中に利用可能な上流ワークアイテムの1つにしてください。
strategy
は、JSONデータ内の親ワークアイテムとワークアイテムに同じ名前のアトリビュートが含まれていた場合の干渉の解決方法を決めます。
デフォルトでは、JSONデータ内のアトリビュートは、親ワークアイテムから継承されたアトリビュートを置換します。
preserve_type
がTrue
の場合、ワークアイテムはシリアライズ化されたJSONデータ内のデータタイプと同じカスタムデータタイプでワークアイテムが作成されます。
False
の場合、ワークアイテムはノードのデフォルトデータタイプを使用します。
preserve_index
がTrue
の場合、ワークアイテムインデックスにはJSONから読み込まれた値が設定されます。
False
の場合、ワークアイテムはparent
ワークアイテムからインデックスを継承します。
add_attributes
がTrue
の場合、元のワークアイテムの名前と状態がアトリビュートとして新規ワークアイテムに追加されます。
addWorkItemFromWorkItem(work_item, parent=None, strategy=pdg.attribCollisionStrategy.Replace, preserve_type=False, preserve_index=True, add_attributes=True)
→ pdg.WorkItem
指定したwork_item
のフィールドに基づいて、新しいワークアイテムをホルダーに追加します。
parent
が指定されている場合、ワークアイテムはそのparent
の依存関係として追加されます。
parent
がNone
でない場合、ワークアイテムは、指定されたワークアイテムの依存関係として追加されます。
このワークアイテムは、ワークアイテム生成中に利用可能な上流ワークアイテムの1つにしてください。
strategy
は、JSONデータ内の親ワークアイテムとワークアイテムに同じ名前のアトリビュートが含まれていた場合の干渉の解決方法を決めます。
デフォルトでは、JSONデータ内のアトリビュートは、親ワークアイテムから継承されたアトリビュートを置換します。
preserve_type
がTrue
の場合、ワークアイテムはシリアライズ化されたJSONデータ内のデータタイプと同じカスタムデータタイプでワークアイテムが作成されます。
False
の場合、ワークアイテムはノードのデフォルトデータタイプを使用します。
preserve_index
がTrue
の場合、ワークアイテムインデックスにはJSONから読み込まれた値が設定されます。
False
の場合、ワークアイテムはparent
ワークアイテムからインデックスを継承します。
add_attributes
がTrue
の場合、元のワークアイテムの名前と状態がアトリビュートとして新規ワークアイテムに追加されます。
commit()
このホルダー内の現在のワークアイテムを確定し、それらのワークアイテムをノードに移動させます。 このホルダーは、この関数がコールされた後にリセットされます。
setCommitCount(count)
#cppname PDG_WorkItemHolder::setCommitCount
このホルダーのコミット数を設定します。 この数のワークアイテムが追加されると、保留中のワークアイテムのリストはホルダーからPDGノードに移動され、ホルダーがリセットされます。
allBatches
: list
of pdg.BatchWorkItem
Property
このホルダーで処理されたバッチワークアイテムの配列。
batches
メソッドとは違って、ワークアイテムがノードにCommitされても、このリストはクリアされません。
allWorkItems
: list
of pdg.WorkItem
Property
このホルダーで処理されたワークアイテムの配列。
workItems
メソッドとは違って、ワークアイテムがノードにCommitされても、このリストはクリアされません。
batches
: list
of pdg.BatchWorkItem
Property
このホルダー内の現在のバッチワークアイテムの配列。 このリストは、ワークアイテムがCommitされる度にクリアされます。
commitCount
: int
Property
ホルダーの内容をPDGノードにコピーする前にそのホルダーに追加可能なワークアイテムの数。 この数に到達すると、保留中のワークアイテムがノードに追加され、ホルダーがリセットされます。
isEmpty
: bool
Property
ホルダーが空っぽの場合はTrue
、そうでない場合はFalse
を返します。
workItems
: list
of pdg.WorkItem
Property
ホルダー内の現在のワークアイテムの配列。 このリストは、ワークアイテムがCommitされる度にクリアされます。
Methods from pdg.DependencyHolder ¶
addDependency(child, parent)
このオブジェクトがノードのマッピングコールバックに渡された時に使用されます。
child
pdg.WorkItemオブジェクトがparent
ワークアイテムオブジェクトに依存するようにします。
Tip
引数の順番は、同じノード内で2個のワークアイテム間にディペンデンシーを作成する場合にのみ重要です。 そうでない場合、このコードは、上流のワークアイテムが下流のワークアイテムに依存するようにしようとした場合、自動的にその順番を逆にしてくれます。