Houdini 20.5 Executing tasks with PDG/TOPs pdg

pdg.EventType module

The type of a pdg.Event

Values

pdg.EventType.All

A special enum that represents the OR of all event types

pdg.EventType.CookStart

Sent for each node in the graph, when a cook starts

pdg.EventType.CookComplete

Sent for each node in the graph, when a cook completes

pdg.EventType.CookError

Sent when an error occurs in the node

pdg.EventType.CookWarning

Sent when an warning is issued by the node

pdg.EventType.DirtyAll

A event indicating that the entire graph is about to be dirtied

pdg.EventType.DirtyStart

A node event indicating that one more items in the node will be dirtied

pdg.EventType.DirtyStop

A node event indicating that the node has finished dirtying items

pdg.EventType.Log

A special enum that represents the OR of both the CookError and CookWarning events

pdg.EventType.NodeClear

A node event that indicates that node is about to have all its work items cleared

pdg.EventType.NodeConnect

Sent when a node was connected to another node

pdg.EventType.NodeCooked

Sent when all work items in a node have finished cooking

pdg.EventType.NodeCreate

Sent when a new node is created

pdg.EventType.NodeDisconnect

Sent when a node is disconnected from another node

pdg.EventType.NodeGenerated

Sent when a node has finished generating or partitioning work items

pdg.EventType.NodeFirstCook

Sent when a node cooks for the first time

pdg.EventType.NodeProgressUpdate

Internal Event

pdg.EventType.NodeRemove

Sent when a node was removed from the graph

pdg.EventType.NodeRename

Sent when a node was renamed

pdg.EventType.NodeSetScheduler

Sent when the scheduler assigned to a node is changed

pdg.EventType.Null

An empty, undefined event

pdg.EventType.SchedulerAdded

Sent when a new scheduler is added to the graph

pdg.EventType.SchedulerRemoved

Sent when a scheduler is removed from the graph

pdg.EventType.ServiceClientStarted

Sent when a service client successfull connects to its service

pdg.EventType.ServiceClientChanged

Sent when the status of a running service clients changes, including when it starts or stops working on a task

pdg.EventType.ServiceManagerAll

Sent whenever the PDG service manager performs an operation (such as starting or stopping a service)

pdg.EventType.ServiceStartBegin

Sent when the PDG service manager begins starting the client processes for a service.

pdg.EventType.ServiceStartEnd

Sent once all of the client processes for a service have started and are ready to accept work items.

pdg.EventType.UISelect

A work item event that indicates the item has been selected in the TOPs UI

pdg.EventType.WorkItemAdd

Sent when a new work item is added

pdg.EventType.WorkItemAddDep

Sent when a work item has a dependency added

pdg.EventType.WorkItemAddParent

Sent from dynamic work items that generate from a cooked item

pdg.EventType.WorkItemCookPercentUpdate

A work item event that indicates that a work item’s cook progress percentage has been updated

pdg.EventType.WorkItemOutputFiles

Sent when output files are added to a work item

pdg.EventType.WorkItemPriority

Sent when a work items priority is changed

pdg.EventType.WorkItemMerge

Sent when a work item merges attributes with upstream dependencies.

pdg.EventType.WorkItemResult

This enum entry/event type is deprecated in favor of pdg.EventType.WorkItemOutputFile.

pdg.EventType.WorkItemRemove

Sent when a work item is deleted

pdg.EventType.WorkItemRemoveDep

Sent when a dependency is removed from a work item

pdg.EventType.WorkItemRemoveParent

Sent when the parent item for a work item is deleted

pdg.EventType.WorkItemSetDict

Sent when a dictionary attribute value is modified on a work item

pdg.EventType.WorkItemSetFile

Sent when a file attribute value is modified on a work item

pdg.EventType.WorkItemSetFloat

Sent when a float attribute value is modified on a work item

pdg.EventType.WorkItemSetGeometry

Sent when a geometry attribute value is modified on a work item

pdg.EventType.WorkItemSetInt

Sent when an int attribute value is modified on a work item

pdg.EventType.WorkItemSetPyObject

Sent when a Python object attribute value is modified on a work item

pdg.EventType.WorkItemSetString

Sent when a string attribute value is modified on a work item

pdg.EventType.WorkItemStateChange

Sent when a work item’s state changes

pdg.EventType.WorkItemAddStaticAncestor

Internal Event

pdg.EventType.WorkItemRemoveStaticAncestor

Internal Event

pdg

attributes

cooking

customtypes

  • pdg.Dictionary

    Wraps a nested dictionary object in Python, used with Dictionary Array attributes

data

debugging

events

exceptions

  • pdg.AttribError

    Generic exception raised when an error occurs when accessing work item attributes

  • pdg.CookError

    Generic exception raised when an error running the graph.

  • pdg.ServiceError

    Generic exception raised when an error occurs during a PDG service manager operation

expressions

  • pdg.EvaluationContext

    A module with global functions that operate on the thread-local evaluation context

internal

nodes

schedulers

services

types

workitems