hm_entitylist

Returns a list of names or IDs of all entities of the requested type.

Syntax

hm_entitylist entity_type name_or_id ?mode?

Type

HyperMesh Tcl Query

Description

Returns a list of names or IDs of all entities of the requested type.

Inputs

entity_type
The type of entity to query.
name_or_id
The type of list to generate. Valid values are:
name - Return the list of names. Only named entity types support this option.
id - Return the list of IDs. All entity types support this option.
mode
An optional argument that specifies which entity types are returned:
active - Return only the active entities. This is the default if not specified.
all - Return both active and inactive entities.
inactive - Return only the inactive entities.

Example

To get the list of node IDs:

hm_entitylist nodes id

To get the list of component names:

hm_entitylist comps name

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

2019 – Added new optional mode argument.