Model.CE_ReviewConnectors

Model.CE_ReviewConnectors(collection_set, operation_type, output_collection_set, consider_geom=True, consider_HAZ_elems=True, find_twince_option=0, filter_projection_entities=0)

Reviews connectors according to user options.

Parameters:

• collection_set (CollectionSet) – The set of collections containing possibly multiple type of entities to review.

• operation_type (hwString) –

  The string for the type of operation to be performed: “findlinks”, “hide”, “isolate”, “isolateonly” and “show”,

  To operate on twin connectors: “twince_hide”, “twince_isolate”, “twince_isolateonly” and “twince_show”.

• output_collection_set (CollectionSet) – The set of collections containing possibly multiple type of entities onto which reviewed entities are placed.

• consider_geom (bool) – Defines if geometry is also considered along with elements during show/hide/isolate operations. Valid values are true and false.

• consider_HAZ_elems (bool) – Defines if HAZ (Heat Affected Zone) elements should also be considered during show/hide/isolate operations. The possible values are true and false.

• find_twince_option (int) –

  Find twin connectors according to:

  1 - Minimum two links

  2 - Exact links

• filter_projection_entities (int) –

  Filters links to the projection entities during show/hide/isolate operations, according to following options which are possible values:

  0 - None

  1 - Projection components

  2 - Projection elements

  3 - Projection and attached elements

Example

Isolate connector with ID 5

import hm
import hm.entities as ent

model = hm.Model()

InputCollectionSet = hm.CollectionSet(model)
connectors = hm.Collection(model, ent.Connector, [5])
InputCollectionSet.set(connectors)
OutputCollectionSet = hm.CollectionSet(model)

model.CE_ReviewConnectors(
        collection_set=InputCollectionSet,
        operation_type="isolate",
        output_collection_set=OutputCollectionSet,
        consider_geom=False,
        consider_HAZ_elems=True,
        find_twince_option=2,
        filter_projection_entities=2
)