Model.hm_ce_getlinkentities#

Model.hm_ce_getlinkentities(connector_entity, ent_type)#

Returns specific type of entities IDs that are added to a connector.

Parameters:

connector_entity (Entity) – The object describing the connector entity.
ent_type (EntityFullType) – Specific entity type required.

Returns:

hwReturnStatus - Status object
HmQueryResult - Result object containing the output values:
- entities (EntityList)

Examples#

Get all the component IDs added to connector of ID 10#

import hm
import hm.entities as ent

model = hm.Model()

ce_col = hm.Collection(model, ent.Connector)

for ce in ce_col:
    _, result = model.hm_ce_getlinkentities(
        connector_entity=ce,
        ent_type=ent.Component
    )

    print("Entities: ", result.entities)

Note

The function will return a list with single or multiple entity IDs.