Model.hm_getentitytypedisplayname

Model.hm_getentitytypedisplayname(EntityTypeName, singular=1)

Returns the display name for the specified entity type.

Parameters:

• EntityTypeName (hwString) – Entity type to query.

• singular (unsigned int) –

  0 - Returns the plural display name

  1 - Returns the singular display name (default)

  2 - Returns the full plural display name

  7 - Returns the full singular display name

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • displayName (str)

Examples

Get the display name of load collector

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getentitytypedisplayname(EntityTypeName="loadcols")

print("Display Name:", result.displayName)

Get the plural display name of load collectors

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getentitytypedisplayname(EntityTypeName="loadcols", singular=0)

print("Display Name:", result.displayName)

Get the full plural display name of load collectors

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getentitytypedisplayname(EntityTypeName="loadcols", singular=2)

print("Display Name:", result.displayName)

Get the full singular display name of load collectors

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getentitytypedisplayname(EntityTypeName="loadcols", singular=7)

print("Display Name:", result.displayName)