hm_getinternalid

Returns the internal HyperMesh ID for a solver ID and solver ID pool.

Syntax

hm_getinternalid id_pool solver_id ?search_type?

Type

HyperMesh Tcl Query Command

Description

This command returns the internal HyperMesh ID for a solver ID and solver ID pool. This command is only applicable to templates and entity types that have ID pools.

Inputs

id_pool: The pool ID or name. By default, the value is assumed to be the pool ID. This is controlled by the optional search_type argument.
solver_id: The solver ID to query.
search_type: Defines whether id_pool is specified as a pool name or a pool ID. Valid values are -bypoolid and -bypoolname. If not specified, it defaults to -bypoolid.

Examples

To get the internal HM ID of pool ID 1 and solver ID 2:

hm_getinternalid 1 2

hm_getinternalid 1 2 -bypoolid

To get the internal HM ID of pool PROP_IDPOOL and solver ID 17:

hm_getinternalid PROP_IDPOOL 17 -bypoolname

Errors

Incorrect usage results in a Tcl error. To detect errors, you can use the catch command:

if { [ catch {command_name...} ] } {
   # Handle error
}