Model.hm_getmodelcheckcheckstatus

Model.hm_getmodelcheckcheckstatus(check_display_name)

Returns the status 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 (int)

    0 - Check is not run

    1 - Check is run and there are failed entities

    2 - Check is run but there are no failed entities

    3 - Relevant entities to run the check are not present in the model

Example

Get the status for the “ Unused materials “ check

import hm
import hm.entities as ent

model = hm.Model()

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

print("status:", result.status)