hm_ce_getlinkentityinfo

Returns specific entity information for a connector.

Syntax

hm_ce_getlinkentityinfo id index

Type

HyperMesh Tcl Query Command

Description

This command returns specific entity information such as entity type, entity name/ID, entity meshed state and re-connect rule. The values are returned as a list in the order type, info, state, rule.

Inputs

id: The ID of the connector.
index: The link index into the connector.

Example

To get entity information for connector ID 1 for all links:

set ce_id 1
set num_ents [hm_ce_numlinkentities $ce_id]
for {set count 0} {$count <= $num_ents} {incr count} {
  foreach {type info state rule} [hm_ce_getlinkentityinfo $ce_id $count] {
    lappend linkArray($type) $info
  }
}

Errors

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

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