hm_getentitytypedisplayname

Returns the display name for the specified entity type.

Syntax

hm_getentitytypedisplayname entity_type ?singular?

Type

HyperMesh Tcl Query Command

Description

This command returns the display name for the specified entity type.

Inputs

entity_type
The entity type to query.
singular
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

Examples

To get the display name of load collector:

hm_getentitytypedisplayname loadcols

or

hm_getentitytypedisplayname loadcols 1

To get the plural display name of load collectors:

hm_getentitytypedisplayname loadcols 0

To get the full plural display name of load collectors:

hm_getentitytypedisplayname loadcols 2

To get the full singular display name of load collectors:

hm_getentitytypedisplayname loadcols 7

Errors

Incorrect usage results in a Tcl error. To detect errors, you can use the catch command:
if { [ catch {command_name...} ] } {
   # Handle error
}

Version History

13.0