spydrnet.get_hcables

spydrnet.get_hcables(obj, ...)[source]

Get hierarchical references to cables within an object.

Parameters:

  • obj (object, Iterable - required) – The object or objects associated with this query. Queries return a collection of objects associated with the provided object or objects that match the query criteria. For example, sdn.get_instances(netlist, …) would return all of the instances within the provided definition that match the additional criteria.

  • patterns (str, Iterable - optional, positional or named, default: wildcard) – The search patterns. Patterns can be a single string or an Iterable collection of strings. Patterns can be absolute or they can contain wildcards or regular expressions. If patterns is not provided, then it defaults to a wildcard.

  • is_case (bool - optional, named, default: True) – Specify if patterns should be treated as case sensitive. Only applies to patterns. Does not alter fast lookup behavior (if namespace policy uses case insensitive indexing, this parameter will not prevent a fast lookup from returning a matching object even if the case is not an exact match).

  • is_re (bool - optional, named, default: False) – Specify if patterns are regular expressions. If False, a pattern can still contain * and ? wildcards. A * matches zero or more characters. A ? matches upto a single character.

  • selection (Selection.{INSIDE, OUTSIDE, BOTH, ALL}, default: INSIDE) – This parameter determines the wires that are returned based on the instance associated with the object that is being searched.

  • recursive (bool - optional, default: False) – Specify if search should be recursive or not meaning that sub hierarchical instances within an instance are included or not.

  • filter (function) – This is a single input function that can be used to filter out unwanted virtual instances. If not specifed, all matching virtual instances are returned. Otherwise, virtual instances that cause the filter function to evaluate to true are the only items returned.

Returns:

href_cables – The hierarchical references to cables associated with a particular object or collection of objects.

Return type:

generator