Model.hm_getunresolvedidcrossreferences#

Model.hm_getunresolvedidcrossreferences(entity, id_pool_id=0)#

Returns entities that are referring to an unresolved ID. The return value is a list of 3 values for each cross-referenced entity.

Parameters:

  • entity (Entity) – The object describing the entity to query.

  • id_pool_id (unsigned int) – The ID of the ID pool to query. If specified, entity_id is taken as a solver ID. If not specified, the id of the entity is taken as an internal ID.

Returns:

  • hwReturnStatus - Status object

  • HmQueryResult - Result object containing the output values:

    • id_pool_name (str)

    • entities (EntityList)

    Note

    For entities with ID pools the IDs returned are the solver IDs. Otherwise, the IDs are the internal IDs. If there is no ID pool for the specified entity type, “” will be returned for id_pool_id.

Example#

Get the list of entity types cross - referencing material unresolved with ID 100#
import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getunresolvedidcrossreferences(
  entity=ent.Material(model, 100),
  id_pool_id=0
)

print("id_pool_name:", result.id_pool_name)
print("entities:", result.entities)