| Inheritance |
|
このオブジェクトには、グラフの参照とそのグラフ内のワークを実行、停止、キャンセルなどするためのメソッドが含まれています。
Warning
TOPネットワークで生成されたグラフに対してノードを追加/削除したりパラメータ値を設定するといった、いわゆるMutateメソッドを使用しないでください。 TOPネットワークは、グラフそのものを管理するためにあります。
メソッド ¶
静的メソッド ¶
findFile(path)
→ str
Static method
PDG検索パスからファイルを検索して、そのファイルの絶対パスを返します。
globFiles(ext, subdir)
→ list
of str
Static method
PDG検索パスの指定したサブディレクトリ下にある、指定した拡張子を持つすべてのファイルを検索します。
globTypeFiles()
→ list
of str
Static method
PDG検索パスからすべての.pyファイルのリストを返します。
names()
→ list
of str
Static method
すべてのアクティブグラフコンテキストの名前を返します。
searchPath()
→ list
of str
Static method
PDG検索パスからパスのリストを返します。
インスタンスメソッド ¶
__init__(name="context")
新しいグラフコンテキストを構築します。nameを指定しなかった場合は、デフォルト名の“context”が使用されます。
その名前は自動的に固有な名前になります。
TOPsでは、TOPネットワークに関連付けられているグラフコンテキストは、そのネットワークオブジェクトと同じ名前を持っています。
addDependency(type_name, node_name, dep_key)
指定した外部依存関係タイプのインスタンスを構築して、それをノードに割り当てます。
addFileDependency(node_name, file_name)
指定したファイル名に対してファイル依存関係を構築し、それをノードに割り当てます。
addNode(type_name, node_name="")
→ pdg.Node
指定したタイプのノードを構築して、それをグラフに追加します。
node_name引数を指定しなかった場合、そのノード名はそのタイプ名から派生します。
addScheduler(type_name, scheduler_name="")
→ pdg.SchedulerBase
指定したタイプのスケジューラを構築して、それをグラフに追加します。
scheduler_name引数を指定しなかった場合、そのスケジューラ名はそのタイプ名から派生します。
addParameter(node_name, port_name, port_label, port_tag, data_type, port_size)
ノードにカスタムパラメータを追加します。tags引数には単一のstr値またはstr値のリストを指定することができます。
data_typeにはpdg.dataTypeを指定してください。
他のすべての引数には文字列を指定してください。
cancelCook()
現行クックをキャンセルします。
cleanTempDirectory(scheduler_name)
指定したスケジュールの一時ファイルディレクトリをクリアします。
cookItems(block, item_ids, node_name)
node_nameという名前のノードから指定したワークアイテムIDをクックします。
blockがTrueの場合、このメソッドはクックが完了するのを待ってから返します。
Falseの場合、このメソッドは即座に返され、クック操作がバックグラウンドで実行されます。
cook(cook_options)
指定したpdg.CookOptionsを使ってグラフコンテキストをクックします。
cook(block, mode=pdg.cookType.Full, name="", ids=pdg.Filter())
個々に指定したクックパラメータを使ってグラフをクックします。 パラメータの説明はpdg.CookOptionsを参照してください。
connect(src_node_name, src_port_name, dst_node_name, dst_port_name)
ソースノードの出力ポートをターゲットノードの入力ポートに接続します。
connect(src_name, dst_name)
ソースノードの出力ポートをターゲットノードの入力ポートに接続します。
これらのポートは、nodename.portname構文を使って指定します。
delete(node_name)
グラフからノードを削除します。
deserializeWorkItemFromJSON(json_text)
→ pdg.WorkItem
標準PDG JSONフォーマットからワークアイテムを読み込みます。
disconnect(src_node_name, src_port_name, dst_node_name, dst_port_name)
ソースノードの出力ポートからターゲットノードの入力ポートの接続を解除します。
disconnect(src_name, dst_name)
ソースノードの出力ポートからターゲットノードの入力ポートの接続を解除します。
これらのポートは、nodename.portname構文を使って指定します。
pauseCook()
クックを停止します。既にクックを開始したプロセスはクックを継続しますが、新しいジョブはスケジューラに送信されなくなります。 この時点で、ワークアイテムとノードがDirty(変更あり)になって、次のクックでは、そのグラフはその変更から再開します。
Note
現在のところ、これはLocal Schedulerを使用した場合にのみ対応しています。
removeDependency(node_name, dep_name)
ノードから外部依存関係を削除します。
renameNode(old_name, new_name)
ノード名をold_nameからnew_nameに変更します。
serializeWorkItemToJSON(work_item, pretty_print=False)
→ str
指定したワークアイテムとそのデータとその入力を.jsonファイルにシリアライズ化します。
pretty_printがTrueの場合、.jsonファイルは人が読みやすいインデントを使った書式で書き出されます。
setDefaultScheduler(scheduler_name)
グラフコンテキストのデフォルトスケジューラを設定します。
setExpression(node_name, port_name, expression, index)
ノードのパラメータにPythonエクスプレッションを設定します。
setExpressions(node_name, dict)
指定したノードに複数のport_name:expressionペアを一括設定します。
setParameter(node_name, port_name, value, index)
Sets a constant value on a node’s parameter to the specified value. If the parameter is numeric and the value is a string, the parameter’s expression is set instead.
setParameters(node_name, dict)
Batch sets multiple parameter:value pairs on the specified node. If the parameter is numeric and the value is a string, the paremter’s expression is set instead.
setScheduler(node_name, scheduler_name)
ノードのスケジューラを設定します。
setValue(node_name, port_name, value, index)
ノードのパラメータに定数値を設定します。
setValues(node_name, dict)
指定したノードに複数のport_name:valueペアを一括設定します。
canceling
: bool
Property
現在のクックがキャンセルされるとTrueに設定されます。
cookOptions
: pdg.CookOptions
Property
このグラフのクックに使用された直近のクックオプションセット。
cooking
: bool
Property
グラフコンテキストがクックされているとTrueに設定されます。
name
: str
Property
コンテキストの名前。
waitAllEvents()
キューに入っているすべてのイベントを放出するまでイベントキューを待機します。
Methods from pdg.EventEmitter ¶
addEventHandler(handler, filter=pdg.EventType.All, pass_handler=False)
→ pdg.PyEventHandler
受信するイベントタイプの値を指定してイベントハンドラーをエミッターに追加します。
handlerには、pdg.Eventタイプの引数に対応したコール可能オブジェクトを指定してください。
pass_handlerがTrueの場合、handler自体が1番目の引数としてこの関数に渡されます。
Falseの場合、イベントオブジェクトのみがこの関数に渡されます。
hasEventHandler(handler)
→ bool
handler関数またはコールバックオブジェクトを使用しているイベントハンドラーをイベントエミッターが既に持っていればTrueを返します。
removeEventHandler(handler)
エミッターからイベントハンドラーを削除します。
removeAllEventHandlers()
エミッターからすべてのイベントハンドラーを削除します。
eventHandlers
→ list
of pdg.EventHandler
Property
エミッターのすべてのアクティブなイベントハンドルのリストを返します。
supportedEventTypes
→ list
of `pdg.EventType
Property
PDGがクック中にこのイベントエミッターが生成できるイベントタイプのリスト。