Model.CE_FE_RegisterAdvanced

Model.CE_FE_RegisterAdvanced(integer_array)

Registers pre-existing FE to multiple connector IDs. Successfully registering pre-existing FE forces a connector to its realized state.

To use this function, a connector must be in user control mode. Also, note that a single FE entity can be registered with, at most, a single connector. Any FE registered with a given connector is treated as part of that connector’s realization.

Parameters:

integer_array (EntityList) – The entity list that contains the FE entities (of type entity_type) to be registered with a given connector.

Example

Register elements with IDs 100 and 101 with connector with ID 10, and elements with IDs 200, 201, and 202 with connector with ID 20.

import hm
import hm.entities as ent

model = hm.Model()

# First, change connectors 10 and 20 to the user control mode:
ce = hm.Collection(model, ent.Connector, [10])
model.CE_SetSpecificDetail(connector_collection=ce, detail_type=2, integer_value=1, double_value=0.0)

# Then, register the element entities with connector 7:
model.CE_FE_RegisterAdvanced(
    integer_array=[
        ent.Element(model, 100),
        ent.Element(model, 101)
    ]
)

# Finally, turn off user control mode for connectors 10 and 20 (optional):
ce = hm.Collection(model, ent.Connector, [10, 20])
model.CE_SetSpecificDetail(connector_collection=ce, detail_type=2, integer_value=0, double_value=0.0)