Model.hm_getmodelcheckcheckname

Model.hm_getmodelcheckcheckname(check_display_name)

Returns the function name 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:

  • functionName (str)

Example

Get the function name for the “ Unused materials “ check

import hm
import hm.entities as ent

model = hm.Model()

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

print("functionName:", result.functionName)