alias_api.search_node_is_instance

alias_api.search_node_is_instance(input_data: alias_api.TraverseDagInputData, expand: bool = False) → alias_api.TraverseDagOutputData

Search the entire DAG for nodes that are instances.

A node is considered an instance if:

  • it is a group node

  • it shares its children with another sibling group node; e.g. when groupNode.isInstanced() = true

  • its previous sibling node is an instance; e.g. when groupNode.prevInstance() is not null

The input_data will be used to filter the output data results. See TraverseDagInputData for more details on how to filter the output data.

NOTE: this is a customized traverse_dag function optimized for this specific use case.

Parameters

  • input_data (TraverseDagInputData) – The input data to pass to the DAG traversal

  • expand (bool) – True will expand the instances, else False to return the data. Defaults to False.

Returns

The status code result of the traversal.

Return type

int(AlStatusCode)