sets

Unless otherwise specified, data names are accessible in level 3 only.

activesuppressed
Returns non-zero if the entity is set inactive, 0 otherwise.
Type: integer
assembly
Pointer to the assemblies for sets of assemblies.
Type: pointer
attributesmax
The number of attributes owned by this entity.
Type: unsigned integer
by
The increment for an ID range clause of a formula set.
Type: integer
cardimage
The name of the assigned card image.
Type: string
cardimagetype
The type of the assigned card image.
Type: string
clauseentitytypenames
The list of clause entity type names for a formula set. Valid for hm_getvalue query only.
Type: unit array
clauseentitytypes
The list of clause entity types for a formula set. Valid for hm_getvalue query only.
Type: unit array
clauses
Pointer to the clauses in a formula set.
Type: pointer
clausesmax
The number of clauses for a formula set.
Type: integer
clausetype
Clause type of a specific clauses clause.
Type: integer
clausetypes
The list of clause types for a formula set. Valid for hm_getvalue query only.
Type: unit array
color
The 1-64 color of the entity.
Type: integer
color_rgb
The RGB color of the entity.
Type: string
component
Pointer to the components for sets of components.
Type: pointer
config
The configurations of the entity.
Type: unsigned integer
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
element
Pointer to the elements for sets of elements.
Type: pointer
elementids
The list of elements IDs.
Type: entity array
elements
The list of elements for segment sets. Valid for hm_getvalue query only.
Type: entity array
end
The end value for an ID range clause of a formula set.
Type: integer
exceptids
The list of except IDs for a specific clause in a formula set. Valid for hm_getvalue query only.
Type: entity array
exceptidsmax
The number of except IDs for a specific clause in a formula set.
Type: integer
facecode
Indicates which face of its element the segment set refers to, 0-5.
Type: integer
faces
Pointer to the faces for segment sets.
Type: pointer
facesmax
The number of faces in the segment set.
Type: integer
facetype
The number of nodes in the current face, 1-8.
Type: integer
id
The ID of the entity.
Type: unsigned integer
ids
Pointer to the entity IDs
Type: pointer value is entity ID
idsmax
The maximum number of IDs.
Type: integer
include
The ID of the include file the entity is organized in.
Type: entity
includeid
The ID of the include file the entity is organized in.
Type: unsigned integer
internalid
The ID of the entity.
Type: unsigned integer
internalids
Pointer to the entity IDs.
Type: pointer value is entity ID
internalname
The internal name of the entity.
Type: string
material
Pointer to the materials for sets of materials.
Type: pointer
moduleid
The module ID of the entity.
Type: integer
name
The name of the entity.
Type: string
node
Pointer to the nodes for sets of nodes.
Type: pointer
node1
The ID of node 1 for the current face. This is reported taking into account whether or not the contact is reversed with respect to the element normal.
Type: entity
node2
The ID of node 2 for the current face. This is reported taking into account whether or not the contact is reversed with respect to the element normal.
Type: entity
node3
The ID of node 3 for the current face. This is reported taking into account whether or not the contact is reversed with respect to the element normal.
Type: entity
node4
The ID of node 4 for the current face. This is reported taking into account whether or not the contact is reversed with respect to the element normal.
Type: entity
node5
The ID of node 5 for the current face. This is reported taking into account whether or not the contact is reversed with respect to the element normal.
Type: entity
node6
The ID of node 6 for the current face. This is reported taking into account whether or not the contact is reversed with respect to the element normal.
Type: entity
node7
The ID of node 7 for the current face. This is reported taking into account whether or not the contact is reversed with respect to the element normal.
Type: entity
node8
The ID of node 8 for the current face. This is reported taking into account whether or not the contact is reversed with respect to the element normal.
Type: entity
nodes
The IDs of the nodes in the current face.
Type: entity array
ordered
0 if non-ordered, 1 if ordered.
Type: integer
outputsuppressed
Returns non-zero if the entity is set "do not export", 0 otherwise.
Type: integer
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
property
Pointer to the properties for sets of properties.
Type: pointer
remove
The remove value for an ID range clause of a formula set.
Type: integer
reversecode
The with/against normal status of the current face.
Type: unsigned integer
rigidlinkconnected
Pointer to a rigid link element to which the node set is attached. Returns 0 for non-nodal sets or for sets not attached to rigid links.
Type: pointer
rigidlinkindependentnodeid
The ID of the independent node of the rigid link element to which the node set is attached. Returns 0 for non-nodal sets or for sets not attached to rigid links.
Type: integer
segment_display_state
The list of display states (0 – off, 1 - on) of segments in set-segment.
Valid only for sets with support value 1.
Type: unsigned integer array
set
Pointer to the sets for sets of sets.
Type: pointer
solver_id
The solver ID of the entity.
Type: integer
solverkeyword
The name of the solver keyword.
Type: string
solvername
The solver name of the entity for entities enabled for name pool, otherwise the internal name of the entity.
Type: string
start
The start value for an ID range clause of a formula set.
Type: integer
style
The style of the entity set.
0 - non-ordered set
1 - ordered set
2 - formula set
3 - compound set
Type: integer
support
The set support type:
-1 - Classic/legacy sets
1 - Segment sets, migrated from the contactsurf entity
2 - Region set
Type: integer
type
The type of set.
1 - nodes
2 - elems
3 - comps
10 - sets
11 - props
16 - mats
17 - assems
41 - multibodies
42 - ellipsoids
46 - mbjoints
47 - mbplanes
49 - contactsurfs
74 - boxes
Type: integer
typename
The type of set. nodes
elems
comps
sets
props
mats
assems
multibodies
ellipsoids
mbjoints
mbplanes
contactsurfs
boxes
Type: string

Version History

2019.1 - Added new data names draft and draftangle.

2020 - Added new data names color, color_rgb, elements, facecode, faces, facesmax, facetype, node1, node2, node3, node4, node5, node6, node7, node8, nodes, reversecode and support.

2020.1 - Added new data name solverkeyword.

2021.1 - Updated data name style with value 3. Added new data names moduleid, poolid, poolname, and solver_id.

2021.2 - Added new data names internalname and solvername.

2022.1 - Added new data name segment_display_state.

2024 - Added new data name config.