hm_attributearrayvalue

Returns the value for a 1D array attribute on an entity for the current template.

Syntax

hm_attributearrayvalue entity_type entity_name_or_id attribute_name_or_id index ?search_type?

Type

HyperMesh Tcl Query

Description

Returns the value for a 1D array attribute on an entity for the current template. If the attribute does not exist on the entity, or is not an attribute from the current template, an error is returned.

Inputs

entity_type: The type of entity to query.
entity_name_or_id: The name or ID of the entity.
attribute_name_or_id: The name or ID of the attribute to query. The attribute must be in the current template.
index: The index of the entry in the 1D array (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 value of the 1D array index 4 for the attribute with name Example on material 6:

hm_attributearrayvalue material 6 Example 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
}

Version History

10-SA1-120