ISchedulingHints

class omni.graph.core.ISchedulingHints

Bases: _ISchedulingHints

Interface to the list of scheduling hints that can be applied to a node type

Methods

__init__(*args, **kwargs)

Overloaded function.

get_data_access(self, data_type)

Get the type of access the node has for a given data type

inspect(self, inspector)

Runs the inspector on the scheduling hints.

set_data_access(self, data_type, new_access_type)

Set the flag describing how a node accesses particular data in its compute _abi (defaults to no access).

Attributes

compute_rule

thread_safety

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: omni.graph.core._omni_graph_core.ISchedulingHints, arg0: omni.core._core.IObject) -> None

  2. __init__(self: omni.graph.core._omni_graph_core.ISchedulingHints) -> None

get_data_access(self: omni.graph.core._omni_graph_core._ISchedulingHints, data_type: omni.graph.core._omni_graph_core.eAccessLocation) omni.graph.core._omni_graph_core.eAccessType

Get the type of access the node has for a given data type

@param[in] dataType Type of data for which access type is being modified @returns Value of the access type flag

inspect(self: omni.graph.core._omni_graph_core.ISchedulingHints, inspector: omni::core::Api<omni::inspect::IInspector_abi>) bool

Runs the inspector on the scheduling hints.

@param[in] inspector The inspector class @return true if the inspection ran successfully, false if the inspection type is not supported

set_data_access(self: omni.graph.core._omni_graph_core._ISchedulingHints, data_type: omni.graph.core._omni_graph_core.eAccessLocation, new_access_type: omni.graph.core._omni_graph_core.eAccessType) None

Set the flag describing how a node accesses particular data in its compute _abi (defaults to no access). Setting any of these flags will, in most cases, automatically mark the node as “not threadsafe”. One current exception to this is allowing a node to be both threadsafe and a writer to USD, since such behavior can be achieved if delayed writebacks (e.g. “registerForUSDWriteBack”) are utilized in the node’s compute method.

@param[in] dataType Type of data for which access type is being modified @param[in] newAccessType New value of the access type flag