::hwat::utils::CreateTag

Creates a tag in HyperMesh.

Syntax

::hwat::utils::CreateTag entityType n_entIDorLocationList label body [color]

Arguments

entityType
Type of entity to which the tag is attached. Legal values include node or element.
n_entIDorLocationList
ID of the entity to which the tag is to be attached, or location at which node should be created and tag attached to newly created node.
label
Content for the tag label.
body
Content for the tag body.
color

The color for the tag.

Default = 1

Returns

Success
ID of the newly created tag
Failure
{}

Example

::hwat::utils::CreateTag node {99} “Node1” “Strike Node”
::hwat::utils::CreateTag node {101 203 405} “Node2” “Strike Node”

Comments

If n_entIDorLocationList has 3 members AND entityType = node, a new node will be created at the given location and the tag will attached to that new node.

For all other cases, the first member of the n_entIDorLocationList will be treated as the entity ID and the tag will be attached accordingly. If no such entity exists, no tag is created and {} is returned to the caller.