hm_attributeindexentityid

Returns the entity ID of an indexed entity attribute on an entity.

Syntax

hm_attributeindexentityid entity_type entity_name_or_id attribute_index ?search_type?

Type

HyperMesh Tcl Query

Description

Returns the entity ID of an indexed entity attribute on an entity. If the entity type is supported by ID pools, the solver ID is returned. Otherwise, the HyperMesh internal ID is returned.

Inputs

entity_type: The type of entity to query.
entity_name_or_id: The name or ID of the entity.
attribute_index: The index of the attribute owned by the queried entity (starting at 1).
search_type: By default, HyperMesh searches for entities by name, and if the name is not found, it then searches by ID. This option allows you to specify how the search for an entity should be conducted. Valid values are:; -byname - Search only by name.; -byid - Search only by ID.

Example

To get the attribute entity ID of the entity attribute with index 4 on property 1:

hm_attributeindexentityid props 1 4 -byid

Errors

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

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