Model.hm_getidpools

Model.hm_getidpools(entity_type, return_type='id')

Returns a list of pool IDs or names for the specified entity type. The pool IDs and names are returned in the same order.

Parameters:

• entity_type (EntityFullType) – The type of entity to query.

• return_type (hwString) – Argument that specifies whether to return pool IDs or names. Valid values are name and ID (default if not specified).

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • Keys valid for return_type="id"

    • idPools (numpy.ndarray)

  • Keys valid for return_type="name"

    • idPools (list of strings)

Examples

Get the pool ID list for elements

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getidpools(entity_type=ent.Element)

print("idPools", result.idPools)

Get the pool ID list for elements

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getidpools(entity_type=ent.Element, return_type="id")

print("idPools", result.idPools)

Get the pool name list for properties

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getidpools(entity_type=ent.Property, return_type="name")

print("idPools", result.idPools)