hm_entityrecorder

Records the IDs of the entities created while the recorder is enabled.

Syntax

hm_entityrecorder entity_type option

Type

HyperMesh Tcl Query Command

Description

Records the IDs of the entities created while the recorder is enabled. This is useful for finding the IDs of multiple entities created during various processes.

The recorder must be turned on to enable recording. It is also important to make sure to turn off the recorder. See the option argument below.

Inputs

entity_type: The type of entity to record. If set to 0, all entity types are recorded.
option: on - Turn on the entity recorder.; off - Turn off the entity recorder.; ids - Get the list of IDs recorded while the recorder is on.; count - Get the number of IDs recorded while the recorder is on.

Example

To record the created components and get the number and list of recorded IDs:

hm_entityrecorder comps on;
<create components>
hm_entityrecorder comps off
set num_comps [hm_entityrecorder comps count]
set comp_ids [hm_entityrecorder comps ids]

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

12.0