Model.hm_getsolverkeyworddiagnosis#

Model.hm_getsolverkeyworddiagnosis(entitytype=EntityFullType(), keyword='', showall=0)#

Returns diagnosis for the registered keywords of a solver profile in form of a single string.

Parameters:

entitytype (EntityFullType) – The entity type for which diagnosis is requested.
keyword (hwString) – The keyword for which diagnosis is requested.
showall (int) – When a non-zero value is specified, the function will return a report for all keywords. Default is 0.

Returns:

hwReturnStatus - Status object
HmQueryResult - Result object containing the output values:
- keyworddiagnosis (str)

Examples#

Query diagnosis for the entire keyword store#

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getsolverkeyworddiagnosis()

print("Diagnosis:", result.keyworddiagnosis)

Query diagnosis for the groups entity type#

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getsolverkeyworddiagnosis(entitytype=ent.Group)

print("Diagnosis:", result.keyworddiagnosis)