Model.hm_modelcheckneedscorrection

Model.hm_modelcheckneedscorrection(check_display_name)

Returns 1 if an auto correction is required for a given check. Checks with auto correction should be run and have failed entities before running this function.

Parameters:

check_display_name (hwString) –

The GUI display name of the check. This is case sensitive.

If not specified, then all checks in the current profile are considered and if any of them require correction and support auto correction, 1 will be returned.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • needsCorrection (bool)

Example

Get the correction status for the “ Unused materials “ check

import hm
import hm.entities as ent

model = hm.Model()

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

print("needsCorrection",result.needsCorrection)