HDK
|
#include <PDG_Node.h>
Classes | |
struct | LoopInfo |
struct | ModTimeCacheEntry |
class | ScopedGenerate |
Public Types | |
enum | RegenerateReason { eRegenerateNone, eRegenerateAlways, eRegenerateFull, eRegeneratePropagate, eRegenerateDirty, eRegenerateDirtyInvalidate } |
Regeneration reasons. More... | |
enum | BypassState { eBypassNone, eBypassSubnetwork, eBypassNode } |
Bypass state for the node. More... | |
Public Types inherited from PDG_NodeInterface | |
using | ParameterGroupArray = UT_Array< ParameterGroup > |
using | DependencyArray = UT_Array< AutoFileDependency > |
Public Types inherited from PDG_EventEmitter | |
using | Filter = UT_ValArray< PDG_EventType > |
using | FilterMap = UT_ArrayMap< PDG_EventHandler *, Filter > |
using | HandlerSet = UT_ArraySet< PDG_EventHandler * > |
using | HandlerArray = UT_Array< PDG_EventHandler * > |
Public Types inherited from PDGE_DependencyOwner | |
using | Array = UT_Array< PDGE_DependencyOwner * > |
using | Set = UT_ArraySet< PDGE_DependencyOwner * > |
Public Member Functions | |
PDG_Node (PDG_GraphContext *context, const UT_StringHolder &name, const PDG_NodeCallbackType *type_object, int id=-1) | |
~PDG_Node () override | |
PDG_EventEmitter::Filter & | supportedEventTypes () const override |
Returns the list of supported event types. More... | |
int64 | getMemoryUsage (bool inclusive) const override |
virtual void | memoryInfo (PDG_MemoryInfo &memory_info, bool inclusive) const |
Returns the memory usage as a PDG_MemoryInfo struct. More... | |
int64 | workItemMemory (bool attribs_only=false) const |
int | getId () const |
Returns this node's id, it matches the TOP node id. More... | |
const UT_StringHolder & | name () const |
Returns the node's unique name. More... | |
void | rename (const UT_StringHolder &new_name) |
bool | performancePath (UT_WorkBuffer &buffer, const UT_StringHolder &event_name, const PDG_WorkItem *work_item) const |
const PDG_NodeCallbackType * | typeObject () const |
Returns the node's type object. More... | |
PDG_NodeType | nodeType () const |
Returns the node type, e.g. processor, mapper, etc. More... | |
PDG_NodeSubtype | nodeSubtype () const |
Returns the sub type, e.g. normal, foreach begin, foreach end, etd. More... | |
const PDG_NodeOptions & | nodeOptions (bool do_update) |
const PDG_SortOptions & | sortOptions () const |
Returns the node's sort options struct. More... | |
const PDG_NodeStats & | stats () const |
Returns the node's stat object. More... | |
PDG_NodeStats & | stats () |
PDG_NodeCallback * | callback () const |
void | setCallback (PDG_NodeCallbackPtr callback) |
PDG_Scheduler * | scheduler () const |
Gets/sets the per-node scheduler override. More... | |
void | setScheduler (PDG_Scheduler *scheduler) |
PDG_SchedulerSet | schedulerReferences () const |
void | addSchedulerReference (PDG_Scheduler *scheduler) |
void | clearSchedulerReferences () |
PDG_GraphContext * | context () const |
Returns the graph context that owns the node. More... | |
int | loopDepth () const |
Returns the loop dpeth of the node. More... | |
PDG_ServiceResetWhen | loopResetWhen () const |
Returns the loop block's service reset conditoon. More... | |
PDG_ServiceResetType | loopResetType () const |
Returns the loop block's service reset type. More... | |
bool | isErrorHandler () const |
Returns true if the node is an error handler. More... | |
bool | isErrorHandlerBranch () const |
Returns true if the node is in an error handler branch. More... | |
void | setIsErrorHandler (bool error_handler) |
Sets the error handler flag on this node. More... | |
void | setIsErrorHandlerBranch (bool error_handler) |
Sets the error handler branch flag on this node. More... | |
bool | hasErrors () const |
Clears and checks the error flag. More... | |
bool | isGenerating () const |
bool | isDynamicEval () const |
bool | isDynamicGeneration () const |
bool | isDynamicProp () const |
bool | canHaveWorkItems () const |
const UT_StringHolder & | serviceName () const |
bool | useServiceBlock () const |
RegenerateReason | regenerateReason () const |
void | setRegenerateReason (RegenerateReason reason) |
void | updateRegenerateReason (RegenerateReason reason) |
void | setBypassState (BypassState state) |
Sets the bypassed flag on this node. More... | |
bool | updateBypassState (BypassState state) |
Updates the bypass flag of this node, if the new state is higher. More... | |
BypassState | bypassState () const |
bool | isBypassed () const |
Returns true if the node is bypassed. More... | |
bool | isLeaf () const |
Returns true if the node is a leaf, i.e it has no descendant nodes. More... | |
bool | isCooked () const |
void | dirty (bool remove_outputs) |
PDG_WorkItemDirty | prepareDirty () |
Prepares a dirty operation that can be applied later. More... | |
void | freeze () |
void | freezeFrom (const PDG_WorkItemArray &work_items) |
Sets the work items in the node from the input list and freezes them. More... | |
bool | cook (bool blocking, UT_WorkBuffer &errors) |
void | cancel () |
Cancels any work items scheduled by this node. More... | |
virtual bool | deserializeWorkItem (PDG_WorkItem *work_item) |
virtual void | commitWorkItem (PDG_WorkItem *work_item) |
Called after a work item is completely deserialized. More... | |
virtual bool | cookWorkItem (PDGE_Resolutions &resolutions, PDG_WorkItem *work_item, bool did_cook) |
Notifies the node that the specified work item has been cooked. More... | |
virtual void | syncWorkItem (PDG_WorkItem *work_item, const PDG_WorkItem *clone_target) |
Syncs data for the work item, using node-specific logic. More... | |
virtual PDG_WorkItemState | isOutputCached (PDG_WorkItem *work_item) const |
int | reserveIndexBlock (int number) |
const PDG_NodeInterface & | templateInterface () const |
PDG_Port * | addCustomParameter (PDGT_Value::DataType type, const UT_StringHolder &name, const UT_StringHolder &label, const UT_StringArray &tags, int size) |
int | connectionCount (PDG_PortType type, bool filter_bypassed=true, bool filter_reference=true) const |
Returns node connectivity information. More... | |
void | connectedNodes (PDG_NodeArray &nodes, PDG_PortType type, bool filter_bypassed=true, bool filter_reference=true) const |
PDG_Node * | firstConnectedNode (PDG_PortType type, bool filter_bypassed=true, bool filter_reference=true) const |
void | connectedAncestors (PDG_NodeSet &nodes, PDG_PortType type, bool filter_bypassed=true, bool filter_reference=true) |
void | addError (const UT_StringHolder &message) const override |
Emits a node level error from the node as PDG_Event. More... | |
void | addWarning (const UT_StringHolder &message) const override |
Emits a node level warning from the node as PDG_Event. More... | |
const UT_Array< PDG_Dependency * > & | dependencies () const |
void | addDependency (PDG_Dependency *dependency) |
void | removeDependency (PDG_Dependency *dependency) |
void | resolveDependencies () |
const PDG_WorkItemArray & | workItems () const |
void | workItemsCopy (PDG_WorkItemArray &array) const |
Returns a safe copy of the work item array. More... | |
template<typename Filter > | |
void | workItemsCopy (PDG_WorkItemArray &array, const Filter &filter) const |
void | batchItemsCopy (PDG_BatchWorkItemSet &set) const |
Returns a safe copy of the batch work item set. More... | |
void | removeItem (PDG_WorkItem *work_item) |
Removes a work item from the node. More... | |
bool | outputFiles (PDG_File::Array &files, bool localize) const |
void | queueWorkItemDeps (PDGE_Evaluator &evaluator, PDG_NodeSet &visited_nodes, PDG_WorkItemSet &visited_items, PDG_Filter &filter) |
Builds evaluation dependencies to cook a specific set of work items. More... | |
bool | preCook (PDG_NodeSet &dirty, PDG_NodeSet &visited, bool &save_scene, bool has_filter) |
Runs precook logic for this node and recurses into input nodes. More... | |
int | preCookLoop () |
Sets the loop depth and loop block reference on the node. More... | |
void | postCook (PDG_NodeSet &visited) |
Runs postcook logic for this node and recurses into input nodes. More... | |
int | addOutputCacheEntry (const UT_StringHolder &file, int cache_id) |
int | addModTimeCacheEntry (const PDG_File &file, const PDG_WorkItem *work_item) |
bool | saveJSON (std::ostream &os, bool binary) |
Serializes the work items in the node to the specified stream. More... | |
bool | saveJSON (const UT_StringHolder &file_path) |
Serializes the work items in the node to the specified file. More... | |
Public Member Functions inherited from PDG_NodeInterface | |
PDG_NodeInterface (UT_StringHolder name="", UT_StringHolder data_type="") | |
virtual | ~PDG_NodeInterface () |
int64 | getMemoryUsage (bool inclusive) const |
void | cloneFrom (const PDG_NodeInterface &interface) |
void | addBuiltinPorts (PDG_NodeType type, PDG_NodeSubtype sub_type) |
Adds builtin ports for the specified node type and subtype. More... | |
PDG_WorkItemDataType * | workItemDataType () |
Queries the work item data type associated with this node. More... | |
const PDG_WorkItemDataType * | workItemDataType () const |
bool | resolveWorkItemDataType (UT_WorkBuffer &errors) |
Resolves and caches the work item data type. More... | |
const PDG_PortArray & | ports (PDG_PortType type) const |
Returns the list of all ports of the specified type. More... | |
const PDG_PortArray & | inputPorts () const |
const PDG_PortArray & | outputPorts () const |
const PDG_PortArray & | parameters () const |
const ParameterGroupArray & | parameterGroups () const |
Returns the list of parameter groups for the node. More... | |
bool | parametersForTag (const UT_StringHolder &tag, PDG_PortArray ¶meters) const |
Returns the list of parameters with the specified tag. More... | |
const PDG_PortArray & | customParameters () const |
Returns the list of custom parameter ports. More... | |
PDG_Port * | port (PDG_PortType type, int index) const |
PDG_Port * | port (PDG_PortType type, const UT_StringHolder &name) const |
PDG_Port * | port (const UT_StringHolder &name) const |
PDG_Port * | inputPort (int index) const |
Specialized functions for finding input ports by name or index. More... | |
PDG_Port * | inputPort (const UT_StringHolder &name) const |
bool | inputPortsForNode (PDG_Node *node, PDG_PortArray &ports) const |
bool | inputPortsForWorkItem (const PDG_WorkItem *work_item, PDG_PortArray &ports) const |
bool | isWorkItemFromInputPort (const PDG_WorkItem *work_item, const UT_StringHolder &name) const |
PDG_Port * | outputPort (int index) const |
Sepcialized functions for finding output ports by name or index. More... | |
PDG_Port * | outputPort (const UT_StringHolder &name) const |
PDG_Port * | parameter (const UT_StringHolder &name, int multi=-1) const |
PDGT_Value * | paramValue (const UT_StringHolder &name, int index=0) const |
PDGT_Value * | defaultParamValue (const UT_StringHolder &name, int index=0) const |
int | portCount (PDG_PortType type) const |
int | inputCount () const |
int | outputCount () const |
int | parameterCount () const |
bool | hasUnorderedPorts () const |
int | numOrderedPorts () const |
PDG_Port * | addPort (PDG_PortType type, const PDG_WorkItemDataType *data_type, const UT_StringHolder &name, const UT_StringHolder &label, const UT_StringArray &tags=UT_StringArray(), int size=0, bool ordered=true, bool custom=false) |
PDG_Port * | addParameter (PDGT_Value::DataType data_type, const UT_StringHolder &name, const UT_StringHolder &label, const UT_StringArray &tags, int size=1, bool custom=false) |
PDG_Port * | addParameter (PDGT_Value::DataType data_type, const UT_StringHolder &name, const UT_StringHolder &label, int size=1, bool custom=false) |
Adds a parameter with a data type, name, label and optional size. More... | |
bool | removeParameter (const UT_StringHolder &name) |
void | addFileDependency (const UT_StringHolder &file_path) |
Adds a new file dependency to the node interface. More... | |
void | addParameterGroup (const UT_StringHolder &name, bool root=true, bool multiparm=false) |
Adds a new parameter group to the node interface. More... | |
void | endParameterGroup () |
Ends the current parameter group. More... | |
const UT_StringHolder & | templateName () const |
bool | isValid () const |
Returns true if the node interface is valid. More... | |
const DependencyArray & | autoDependencies () const |
Returns the list of external files that this node depends on. More... | |
const PDG_Port::ExpressionVars & | commonVars () const |
PDG_ApplicationShim::Node * | appNode () const |
template<typename T , typename... Args> | |
void | setAppNode (Args &&...args) |
Sets the underlying app node. More... | |
const PDG_AttributeInfo & | attributeInfo () const |
void | setAttributeInfo (const PDG_AttributeInfo &info) |
Clears and sets the attribute info for this interface. More... | |
const PDG_JobScriptInfo & | scriptInfo () const |
Returns the script info for this node interface. More... | |
void | setScriptInfo (const PDG_JobScriptInfo &info) |
Sets the script info for the interface. More... | |
void | setServiceCompatibility (const UT_StringHolder &service_type_name, bool compatible) |
template<typename... Args> | |
void | addErrorFmt (const char *fmt, Args &&...args) const |
Adds an error using a format string, instead of plain string. More... | |
template<typename... Args> | |
void | addWarningFmt (const char *fmt, Args &&...args) const |
Adds a warning using a format string, instead of plain string. More... | |
template<typename T > | |
bool | evaluate (T &result, const UT_StringHolder &name, const PDG_WorkItem *work_item=nullptr, int index=0, int multi=-1) const |
Evaluates a parameter and reports errors if desired. More... | |
bool | evaluateRaw (UT_StringHolder &result, const UT_StringHolder &name, const PDG_WorkItem *work_item=nullptr, int index=0, int multi=-1) const |
template<typename T > | |
bool | evaluateArray (T &result, const UT_StringHolder &name, const PDG_WorkItem *work_item=nullptr, int multi=-1) const |
Evaluates a parameter as an array and reports errors if desired. More... | |
Public Member Functions inherited from PDG_EventEmitter | |
PDG_EventEmitter (PDG_EventQueue *eventQueue, bool block_destruction) | |
virtual | ~PDG_EventEmitter () |
int64 | getMemoryUsage (bool inclusive) const |
Returns memory usage for this event emitter instance. More... | |
bool | addEventHandler (PDG_EventHandler *handler) |
Adds an event handlers that listens for all types of events. More... | |
bool | addEventHandler (PDG_EventHandler *handler, PDG_EventType event) |
Adds an event handlers that listens for a specific event. More... | |
bool | addEventHandler (PDG_EventHandler *handler, const Filter &filter) |
void | removeEventHandler (PDG_EventHandler *handler) |
Removes an event handler from this emitter. More... | |
void | removeAllEventHandlers (bool user_handler_only=false) |
void | emitEvent (const PDG_Event &evt) const |
Emit an event to all handlers. More... | |
void | eventHandlers (HandlerArray &handlers) const |
void | setEventQueue (PDG_EventQueue *eventQueue) |
void | eventQueueDestroyed () |
Public Member Functions inherited from PDGE_DependencyOwner | |
PDGE_DependencyOwner () | |
Constructs a new dependency owner, which must have a string name. More... | |
virtual | ~PDGE_DependencyOwner () |
virtual UT_StringHolder | debugGroup () const |
Static Public Member Functions | |
static void | queueNodeDeps (PDGE_Evaluator &evaluator, const PDG_NodeSet &leaf_nodes, const PDG_NodeSet &error_handlers, bool generate_only, bool cook) |
Queues node dependencies for cooking with the evaluator. More... | |
Static Public Member Functions inherited from PDGE_DependencyOwner | |
template<typename T > | |
static void | cast (UT_Array< T > &out, const Array &in) |
Converts an owner array to an array of the specified type. More... | |
template<typename T > | |
static void | cast (Array &out, const UT_Array< T > &in) |
Converts an array of the specified type to an owner array. More... | |
Protected Types | |
enum | CookWhen { eCookNone, eCookDeferred, eCookImmediate } |
Enumerations of cook conditions. More... | |
enum | TargetedBy { eTargetedNone = 0x0, eTargetedAll = 0x1, eTargetedEach = 0x2 } |
Enumeration of targeting conditions. More... | |
Friends | |
class | PDG_BatchWorkItem |
class | PDG_Mapper |
class | PDG_Processor |
class | PDG_Partitioner |
class | PDG_WorkItem |
class | PDG_WorkItemDirty |
Base class for all nodes that keeps track of work items and helper data structures needed by sub classes. Defines several virtual methods that are implemented in concrete node subclasses.
Definition at line 57 of file PDG_Node.h.
Bypass state for the node.
Enumerator | |
---|---|
eBypassNone |
The node is not bypassed. |
eBypassSubnetwork |
The node is in a bypassed subnetwork. |
eBypassNode |
The node itself is bypassed. |
Definition at line 87 of file PDG_Node.h.
|
protected |
Enumerations of cook conditions.
Definition at line 542 of file PDG_Node.h.
Regeneration reasons.
Definition at line 63 of file PDG_Node.h.
|
protected |
Enumeration of targeting conditions.
Definition at line 558 of file PDG_Node.h.
PDG_Node::PDG_Node | ( | PDG_GraphContext * | context, |
const UT_StringHolder & | name, | ||
const PDG_NodeCallbackType * | type_object, | ||
int | id = -1 |
||
) |
|
override |
|
protectedvirtual |
Reimplemented in PDG_Partitioner.
PDG_Port* PDG_Node::addCustomParameter | ( | PDGT_Value::DataType | type, |
const UT_StringHolder & | name, | ||
const UT_StringHolder & | label, | ||
const UT_StringArray & | tags, | ||
int | size | ||
) |
Adds a custom/spare parameter to the node and returns a pointer to the the parameter port.
void PDG_Node::addDependency | ( | PDG_Dependency * | dependency | ) |
|
overridevirtual |
Emits a node level error from the node as PDG_Event.
Reimplemented from PDG_NodeInterface.
Reimplemented in PDG_Processor, PDG_Partitioner, and PDG_Mapper.
int PDG_Node::addModTimeCacheEntry | ( | const PDG_File & | file, |
const PDG_WorkItem * | work_item | ||
) |
Adds or updates the dependent file attribute cache, and returns a new cache ID for the work itme based on the entry.
int PDG_Node::addOutputCacheEntry | ( | const UT_StringHolder & | file, |
int | cache_id | ||
) |
Adds or updates an existing file cache entry with the specified cache id. This will create an entry if one does not yet exist.
|
protected |
|
inline |
Definition at line 184 of file PDG_Node.h.
|
overridevirtual |
Emits a node level warning from the node as PDG_Event.
Reimplemented from PDG_NodeInterface.
|
protectedvirtual |
Reimplemented in PDG_Processor.
|
protected |
|
protected |
|
inlineprotected |
Definition at line 580 of file PDG_Node.h.
void PDG_Node::batchItemsCopy | ( | PDG_BatchWorkItemSet & | set | ) | const |
Returns a safe copy of the batch work item set.
|
inline |
Definition at line 303 of file PDG_Node.h.
|
protectedvirtual |
Reimplemented in PDG_Processor, and PDG_Partitioner.
|
inline |
Gets/sets the node callback - the underlying object used to implement most of the node functionality. Can be a user defined C++ or Python instance.
Definition at line 171 of file PDG_Node.h.
void PDG_Node::cancel | ( | ) |
Cancels any work items scheduled by this node.
|
inlineprotected |
Definition at line 583 of file PDG_Node.h.
|
inline |
Returns true if this node can possibly create work items, based on its input configuration
Definition at line 252 of file PDG_Node.h.
|
protectedvirtual |
Reimplemented in PDG_Processor, and PDG_Partitioner.
|
protected |
|
inline |
Definition at line 186 of file PDG_Node.h.
|
protectedvirtual |
Reimplemented in PDG_Processor, and PDG_Partitioner.
|
virtual |
Called after a work item is completely deserialized.
Reimplemented in PDG_Processor, and PDG_Partitioner.
|
protected |
void PDG_Node::connectedAncestors | ( | PDG_NodeSet & | nodes, |
PDG_PortType | type, | ||
bool | filter_bypassed = true , |
||
bool | filter_reference = true |
||
) |
void PDG_Node::connectedNodes | ( | PDG_NodeArray & | nodes, |
PDG_PortType | type, | ||
bool | filter_bypassed = true , |
||
bool | filter_reference = true |
||
) | const |
int PDG_Node::connectionCount | ( | PDG_PortType | type, |
bool | filter_bypassed = true , |
||
bool | filter_reference = true |
||
) | const |
Returns node connectivity information.
|
inline |
Returns the graph context that owns the node.
Definition at line 190 of file PDG_Node.h.
bool PDG_Node::cook | ( | bool | blocking, |
UT_WorkBuffer & | errors | ||
) |
Cooks the node. This is a utility method that calls the standard cook logic on the the graph context
|
virtual |
Notifies the node that the specified work item has been cooked.
Reimplemented in PDG_Partitioner.
|
inlineoverrideprotectedvirtual |
Debug name for this dependency owner object, used when various debug utilities are enabled
Implements PDGE_DependencyOwner.
Definition at line 593 of file PDG_Node.h.
const UT_Array<PDG_Dependency*>& PDG_Node::dependencies | ( | ) | const |
Handler for external dependencies, e.g. files. External dependencies that are added to the node will be resolved just before a work item in the node is cooked.
|
virtual |
Inserts a work item into the node after it has been deserialized. Based on the type of the item, it will be added to the various structures (wrapper list, partition maps, etc).
Reimplemented in PDG_Processor, and PDG_Partitioner.
void PDG_Node::dirty | ( | bool | remove_outputs | ) |
Dirties the node by deleting all static and dynamic work items, and dirtying (but not deleting) wrappers
|
protected |
PDG_Node* PDG_Node::firstConnectedNode | ( | PDG_PortType | type, |
bool | filter_bypassed = true , |
||
bool | filter_reference = true |
||
) | const |
void PDG_Node::freeze | ( | ) |
Freezes all work items in the node and their associated attribute data.
void PDG_Node::freezeFrom | ( | const PDG_WorkItemArray & | work_items | ) |
Sets the work items in the node from the input list and freezes them.
|
inline |
Returns this node's id, it matches the TOP node id.
Definition at line 125 of file PDG_Node.h.
|
overridevirtual |
Returns the total memory usage of the node, including any work items owned by it.
Reimplemented from PDGE_DependencyOwner.
|
inline |
Clears and checks the error flag.
Definition at line 225 of file PDG_Node.h.
|
protected |
|
inline |
Returns true if the node is bypassed.
Definition at line 307 of file PDG_Node.h.
bool PDG_Node::isCooked | ( | ) | const |
Returns true if the node is cooked, i.e. all wrappers and static items are cooked.
|
inlineprotected |
Definition at line 587 of file PDG_Node.h.
|
inline |
Returns true if this node is dynamic for the current evaluation, e.g. if it should have the dynamic badge set in the UI. This means either this node or an upstream input is dynamic in some way.
Definition at line 237 of file PDG_Node.h.
|
inline |
Returns true if this node itself is strictly dynamic, i.e. the work item generation requires input items to be cooked
Definition at line 242 of file PDG_Node.h.
|
inline |
Returns true if this node should propagate the dynamic generation state to downstream processors
Definition at line 247 of file PDG_Node.h.
|
inline |
Returns true if the node is an error handler.
Definition at line 206 of file PDG_Node.h.
|
inline |
Returns true if the node is in an error handler branch.
Definition at line 210 of file PDG_Node.h.
|
inlineprotected |
Definition at line 585 of file PDG_Node.h.
|
inline |
Returns true if this node is generating. This occurs when the atomic generation counter is > 0
Definition at line 231 of file PDG_Node.h.
bool PDG_Node::isLeaf | ( | ) | const |
Returns true if the node is a leaf, i.e it has no descendant nodes.
|
inlinevirtual |
Checks if a work item is cached based on its expected outputs and the current output cache state
Reimplemented in PDG_Processor.
Definition at line 359 of file PDG_Node.h.
|
inline |
Returns the loop dpeth of the node.
Definition at line 194 of file PDG_Node.h.
|
inline |
Returns the loop block's service reset type.
Definition at line 202 of file PDG_Node.h.
|
inline |
Returns the loop block's service reset conditoon.
Definition at line 198 of file PDG_Node.h.
|
virtual |
Returns the memory usage as a PDG_MemoryInfo struct.
Reimplemented in PDG_Processor, PDG_Partitioner, and PDG_Mapper.
|
inline |
Returns the node's unique name.
Definition at line 129 of file PDG_Node.h.
|
protected |
const PDG_NodeOptions& PDG_Node::nodeOptions | ( | bool | do_update | ) |
Returns the node's info object, which contains cook count and description information.
PDG_NodeSubtype PDG_Node::nodeSubtype | ( | ) | const |
Returns the sub type, e.g. normal, foreach begin, foreach end, etd.
PDG_NodeType PDG_Node::nodeType | ( | ) | const |
Returns the node type, e.g. processor, mapper, etc.
bool PDG_Node::outputFiles | ( | PDG_File::Array & | files, |
bool | localize | ||
) | const |
Aggregates output files from all work items. Safe to call from multiple threads or during a cook, and will return false/empty result if the serial lock cannot be acquired
bool PDG_Node::performancePath | ( | UT_WorkBuffer & | buffer, |
const UT_StringHolder & | event_name, | ||
const PDG_WorkItem * | work_item | ||
) | const |
Returns the performance event path for the node. Returns true if the path already includes work item information.
void PDG_Node::postCook | ( | PDG_NodeSet & | visited | ) |
Runs postcook logic for this node and recurses into input nodes.
|
protectedvirtual |
Reimplemented in PDG_Processor.
bool PDG_Node::preCook | ( | PDG_NodeSet & | dirty, |
PDG_NodeSet & | visited, | ||
bool & | save_scene, | ||
bool | has_filter | ||
) |
Runs precook logic for this node and recurses into input nodes.
|
protectedvirtual |
Reimplemented in PDG_Processor.
int PDG_Node::preCookLoop | ( | ) |
Sets the loop depth and loop block reference on the node.
Reimplemented in PDG_Partitioner, and PDG_Mapper.
PDG_WorkItemDirty PDG_Node::prepareDirty | ( | ) |
Prepares a dirty operation that can be applied later.
|
protected |
|
inlineprotected |
Definition at line 590 of file PDG_Node.h.
|
static |
Queues node dependencies for cooking with the evaluator.
|
protected |
|
inlineprotectedvirtual |
Reimplemented in PDG_Partitioner.
Definition at line 606 of file PDG_Node.h.
void PDG_Node::queueWorkItemDeps | ( | PDGE_Evaluator & | evaluator, |
PDG_NodeSet & | visited_nodes, | ||
PDG_WorkItemSet & | visited_items, | ||
PDG_Filter & | filter | ||
) |
Builds evaluation dependencies to cook a specific set of work items.
|
protected |
|
inline |
Returns true if this node should run its automatic regeneration logic on the next cook. If this node has a callback with a custom onRegenerate implementation, that will always be run regardless of this flag
Definition at line 270 of file PDG_Node.h.
void PDG_Node::removeDependency | ( | PDG_Dependency * | dependency | ) |
void PDG_Node::removeItem | ( | PDG_WorkItem * | work_item | ) |
Removes a work item from the node.
void PDG_Node::rename | ( | const UT_StringHolder & | new_name | ) |
Renames the node. No uniqueness validation is done on the new name - a unique name should be acquired from the graph.
|
protectedvirtual |
Reimplemented in PDG_Partitioner.
Reserves a number of work item indices in a contiguous block, and returns the first index value.
|
overrideprotectedvirtual |
Resets the owner.
Reimplemented from PDGE_DependencyOwner.
Reimplemented in PDG_Processor, and PDG_Partitioner.
void PDG_Node::resolveDependencies | ( | ) |
bool PDG_Node::saveJSON | ( | std::ostream & | os, |
bool | binary | ||
) |
Serializes the work items in the node to the specified stream.
bool PDG_Node::saveJSON | ( | const UT_StringHolder & | file_path | ) |
Serializes the work items in the node to the specified file.
PDG_Scheduler* PDG_Node::scheduler | ( | ) | const |
Gets/sets the per-node scheduler override.
|
inline |
Gets/sets schedulers referenced by this node, but not used by it directly.
Definition at line 182 of file PDG_Node.h.
|
inline |
Returns the name of the service that this node should use to cook work items. Returns empty string if no service has been specified in the node configuration
Definition at line 258 of file PDG_Node.h.
|
inline |
Sets the bypassed flag on this node.
Definition at line 287 of file PDG_Node.h.
|
inline |
Definition at line 173 of file PDG_Node.h.
|
inline |
Sets the error handler flag on this node.
Definition at line 214 of file PDG_Node.h.
|
inline |
Sets the error handler branch flag on this node.
Definition at line 221 of file PDG_Node.h.
|
inline |
Sets the regenerate flag, to be called when the node should consider running automatic regeneration logic during the cook
Definition at line 275 of file PDG_Node.h.
void PDG_Node::setScheduler | ( | PDG_Scheduler * | scheduler | ) |
|
inlineprotectedvirtual |
Reimplemented in PDG_Processor.
Definition at line 616 of file PDG_Node.h.
|
inline |
Returns the node's sort options struct.
Definition at line 159 of file PDG_Node.h.
|
inline |
Returns the node's stat object.
Definition at line 163 of file PDG_Node.h.
|
inline |
Definition at line 165 of file PDG_Node.h.
|
overridevirtual |
Returns the list of supported event types.
Implements PDG_EventEmitter.
|
inlinevirtual |
Syncs data for the work item, using node-specific logic.
Reimplemented in PDG_Processor.
Definition at line 353 of file PDG_Node.h.
const PDG_NodeInterface& PDG_Node::templateInterface | ( | ) | const |
Returns the node interface/template that describes the default parameters and connections for the node
const PDG_NodeCallbackType* PDG_Node::typeObject | ( | ) | const |
Returns the node's type object.
|
inlineprotected |
Definition at line 666 of file PDG_Node.h.
|
inline |
Updates the bypass flag of this node, if the new state is higher.
Definition at line 291 of file PDG_Node.h.
|
protected |
|
protected |
|
inline |
Updates the regenerate flag, but only to mode that's higher in value then the current one
Definition at line 280 of file PDG_Node.h.
|
protected |
|
inline |
Returns true if the node is inheriting it's service from a parent service block.
Definition at line 263 of file PDG_Node.h.
int64 PDG_Node::workItemMemory | ( | bool | attribs_only = false | ) | const |
Returns the memory used by all work items in this node. Pass true indicate that only attribute data should be counted.
|
inline |
Returns the underyling work item array. This method is not safe to call from external code if a cook or dirty is in progress.
Definition at line 421 of file PDG_Node.h.
void PDG_Node::workItemsCopy | ( | PDG_WorkItemArray & | array | ) | const |
Returns a safe copy of the work item array.
|
inline |
Returns a safe copy of the work item array with a filter. The filter function is called for each work item, and can return false to indicate that the work item shouldn't be included in the copied list
Definition at line 431 of file PDG_Node.h.
|
friend |
Definition at line 573 of file PDG_Node.h.
|
friend |
Definition at line 574 of file PDG_Node.h.
|
friend |
Definition at line 576 of file PDG_Node.h.
|
friend |
Definition at line 575 of file PDG_Node.h.
|
friend |
Definition at line 577 of file PDG_Node.h.
|
friend |
Definition at line 578 of file PDG_Node.h.
|
protected |
Definition at line 737 of file PDG_Node.h.
|
mutableprotected |
Definition at line 743 of file PDG_Node.h.
|
protected |
Definition at line 704 of file PDG_Node.h.
|
protected |
Definition at line 732 of file PDG_Node.h.
|
protected |
Definition at line 716 of file PDG_Node.h.
|
protected |
Definition at line 698 of file PDG_Node.h.
|
protected |
Definition at line 756 of file PDG_Node.h.
|
protected |
Definition at line 719 of file PDG_Node.h.
|
protected |
Definition at line 730 of file PDG_Node.h.
|
protected |
Definition at line 708 of file PDG_Node.h.
|
protected |
Definition at line 707 of file PDG_Node.h.
|
protected |
Definition at line 755 of file PDG_Node.h.
|
mutableprotected |
Definition at line 754 of file PDG_Node.h.
|
protected |
Definition at line 753 of file PDG_Node.h.
|
protected |
Definition at line 740 of file PDG_Node.h.
|
protected |
Definition at line 728 of file PDG_Node.h.
|
protected |
Definition at line 751 of file PDG_Node.h.
|
protected |
Definition at line 762 of file PDG_Node.h.
|
protected |
Definition at line 700 of file PDG_Node.h.
|
protected |
Definition at line 749 of file PDG_Node.h.
|
protected |
Definition at line 748 of file PDG_Node.h.
|
protected |
Definition at line 750 of file PDG_Node.h.
|
protected |
Definition at line 758 of file PDG_Node.h.
|
protected |
Definition at line 759 of file PDG_Node.h.
|
protected |
Definition at line 763 of file PDG_Node.h.
|
protected |
Definition at line 761 of file PDG_Node.h.
|
protected |
Definition at line 699 of file PDG_Node.h.
|
protected |
Definition at line 727 of file PDG_Node.h.
|
protected |
Definition at line 735 of file PDG_Node.h.
|
protected |
Definition at line 734 of file PDG_Node.h.
|
protected |
Definition at line 741 of file PDG_Node.h.
|
protected |
Definition at line 712 of file PDG_Node.h.
|
mutableprotected |
Definition at line 746 of file PDG_Node.h.
|
protected |
Definition at line 714 of file PDG_Node.h.
|
protected |
Definition at line 694 of file PDG_Node.h.
|
protected |
Definition at line 695 of file PDG_Node.h.
|
protected |
Definition at line 710 of file PDG_Node.h.
|
mutableprotected |
Definition at line 745 of file PDG_Node.h.
|
protected |
Definition at line 701 of file PDG_Node.h.
|
protected |
Definition at line 731 of file PDG_Node.h.
|
protected |
Definition at line 721 of file PDG_Node.h.
|
protected |
Definition at line 722 of file PDG_Node.h.
|
protected |
Definition at line 724 of file PDG_Node.h.
|
protected |
Definition at line 696 of file PDG_Node.h.
|
protected |
Definition at line 706 of file PDG_Node.h.
|
protected |
Definition at line 726 of file PDG_Node.h.
|
protected |
Definition at line 738 of file PDG_Node.h.
|
protected |
Definition at line 717 of file PDG_Node.h.
|
protected |
Definition at line 765 of file PDG_Node.h.
|
mutableprotected |
Definition at line 744 of file PDG_Node.h.
|
protected |
Definition at line 703 of file PDG_Node.h.