Model.CE_ReviewLinks

Model.CE_ReviewLinks(collection, operation_type, output_collectionset, consider_geom=True, consider_HAZ_elems=True, find_twince_option=1, filter_projection_entities=0)

Reviews links according to user options.

Parameters:

• collection (Collection) – The collection containing the connector entities to review.

• operation_type (hwString) –

  The string for the type of operation to be performed: “find”, “findattached”, “findbetween”, “hide”, “isolate”, “isolateonly” and “show”.

  To operate on between links: “cebetween_hide”, “cebetween_isolate”, “cebetween_isolateonly” and “cebetween_show”.

• output_collectionset (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 components with ID 2 and 4 with no overwritten user options

import hm
import hm.entities as ent

model = hm.Model()

InputCollectionSet = hm.CollectionSet(model)
component2 = hm.Collection(model, ent.Component, [2])
component4 = hm.Collection(model, ent.Component, [4])
InputCollectionSet.set(component2)
InputCollectionSet.set(component4)
OutputCollectionSet = hm.CollectionSet(model)

model.CE_ReviewLinks(
        collection=InputCollectionSet,
        operation_type="isolate",
        output_collectionset=OutputCollectionSet,
        consider_geom=True,
        consider_HAZ_elems=True,
        find_twince_option=0,
        filter_projection_entities=2
)