Model.hm_getmodelcheckcheckresult

Model.hm_getmodelcheckcheckresult(check_display_name)

Returns the result for a given check.

Parameters:

check_display_name (hwString) – The GUI display name of the check. This is case sensitive.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • status (bool) - True if check is run and false otherwise

  • numberOfFailedEntities (int) - The count of failed entities

  • entityIdList (numpy.ndarray) - The IDs of the failed entities

Example

Get the result for the “ Unused materials “ check

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getmodelcheckcheckresult(
    check_display_name="Unused materials"
)

print("status:", result.status)
print("stanumberOfFailedEntitiestus:", result.numberOfFailedEntities)
print("entityIdList:", result.entityIdList)