Model.hm_getsolverkeywordinfo

Model.hm_getsolverkeywordinfo(entitytype, format=0)

Queries the registered solver keywords.

Parameters:

• entitytype (EntityFullType) – The entity type for which diagnosis is requested.

• format (int) – When set to non-zero value, the keywords will be sorted based on priorities identified and registered in the solver browser folder.

Returns:

• hwReturnStatus - Status object

• HmQueryResultList - Result list object containing HmQueryResult objects with the following output data:

  • keyword (str) - The registered keyword for the entity type.

Examples

Query keywords of group entity

import hm
import hm.entities as ent

model = hm.Model()

_, resultlist = model.hm_getsolverkeywordinfo(entitytype=ent.Group)

for result in resultlist:
    print("Keyword:", result.keyword)

Query keywords of set entity with priority sorting

import hm
import hm.entities as ent

model = hm.Model()

_, resultlist = model.hm_getsolverkeywordinfo(entitytype=ent.Set, format=1)

for result in resultlist:
    print("Keyword:", result.keyword)