Model.hm_getmodelcheckdisplaynames

Model.hm_getmodelcheckdisplaynames(check_type="ALL", entity_type=EntityFullType()))

Returns check display names.

Parameters:

• check_type (hwString) – The type of check, ERROR, WARNING, INFO or ALL. If blank, then all checks of all types are returned.

• entity_type (EntityFullType) – The type of entity. If ALL, then checks for all entity types in the profile are returned.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • displayNames (list of strings)

Examples

Get the check names for all check and entity types

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getmodelcheckdisplaynames()

print("displayNames:", result.displayNames)

or

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getmodelcheckdisplaynames(check_type="ALL")

print("displayNames:", result.displayNames)

Get the check names for ERROR for material entities

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getmodelcheckdisplaynames(check_type="ERROR", entity_type=ent.Material)

print("displayNames:", result.displayNames)