Model.writemodelcheckresultfile

Model.writemodelcheckresultfile(filename, filetype)

Writes out model check results to a file.

Parameters:

• filename (hwString) – The full path and name of the file to write. By default is given a .txt extension if not specified.

• filetype (int) –

  0 or 1 - Only the failed count associated with the checks is written out.

  2 - Entity type, failed count, and count of entities in the model are written against the check.

  3 - Along with the above information, the time taken to run each check is also written out.

  4 - A detailed CSV report with entity type, run status, failed count, comments, and failed entity IDs against each check is generated.

  5 - Writes out failed count against only failed checks flagged under the user status column.

Example

Write results to the file C:/temp / check_results.txt

import hm
import hm.entities as ent

model = hm.Model()

model.writemodelcheckresultfile(filename="C:/temp/check_results.txt", filetype=1)