Model.hm_getentityname#

Model.hm_getentityname(entity_type_id, style=0)#

Returns the fully qualified HyperMesh entity name for the specified entity_type_id. Each entity type in HyperMesh is assigned a unique ID. This ID is converted to the entity type name using this function.

If entity_type_id is not valid, undefined will be returned.

This is the inverse of the Model.hm_getentitytype() function.

Parameters:

entity_type_id (unsigned int) – The unique entity type ID.
style (unsigned int) – The type of name style. Valid values are 0-7.

Returns:

hwReturnStatus - Status object
HmQueryResult - Result object containing the output values:
- entityName (str)

Examples#

Get the name of entity type 1 ( nodes )#

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getentityname(entity_type_id=1)

print("entityName", result.entityName)

Get the name of entity type 11 ( properties )#

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getentityname(entity_type_id=11)

print("entityName", result.entityName)

Get the name of entity type 8 ( load collectors )#

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getentityname(entity_type_id=8, style=6)

print("entityName", result.entityName)