Model.hm_getidpoolsforidrange

Model.hm_getidpoolsforidrange(entity_type, solver_id_range)

Returns a list of pool names for the specified entity_type and solver_id_range. The solver_id_range must be specified using solver ID values. The range must be specified using a dash - to define the range. Only one continuous range may be specified.

If a entity of entity_type exists with the same solver ID in multiple pools, all pools containing that solver ID will be returned. This function is only applicable to templates that support ID pools.

Parameters:

• entity_type (EntityFullType) – The input entity type.

• solver_id_range (hwString) – The range of IDs.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • Idpools (list of strings)

Example

Get the list of pool names for elements with solver IDs 100 - 300

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getidpoolsforidrange(entity_type=ent.Element, solver_id_range="100-300")

print("Idpools", result.Idpools)