Model.hm_getentitybasename#

Model.hm_getentitybasename(entity_type, style=INT_MAX)#

Returns the fully qualified entity name for the partial or short name.

Parameters:

  • entity_type (hwString) – Any entity name or partial name.

  • style (int) – The type of name style. Valid values are 0-7.

Returns:

  • hwReturnStatus - Status object

  • HmQueryResult - Result object containing the output values:

    • entityName (str) - The base name of the entity in the specified style.

Example#

Get all name variations for property entity type#
import hm
import hm.entities as ent

model = hm.Model()

for style in range(8):
    _, result = model.hm_getentitybasename(entity_type="property", style=style)
    print(f"Style {style}: {result.entityName}")