modules

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
attributesmax: The number of attributes owned by this entity.; Type: unsigned integer
children: Recursive list of children module IDs. Valid for hm_getvalue query only.; Type: integer array
childrenids: Recursive list of children module IDs. Valid for hm_getvalue query only.; Type: integer array
color: The 1-64 color of the entity.; Type: integer
color_rgb: The RGB color of the entity.; Type: string
config: The configuration of the entity.; 1 - Prototype; 2 - Occurrence; Type: unsigned integer
conflictidlist: The list of conflict IDs as internal IDs, with reserve range. If row=<entity_type> is specified, this will be for the specific entity type in the module. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer array
conflictwithreservedids: The list of conflict IDs with reserve range. If row=<entity_type> is specified, this will be for the specific entity type in the module. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: string
correctoptions: List of ID manager correction options. Valid for hm_getvalue query only.; Type: string
creator_tag: The tag that defines the creator/use case of the module. Valid for hm_getvalue query only.; Type: string
currentcorrectoption: The current ID manager correction option.; Type: string
currentnewidoption: The current ID manager new ID option.; Type: string
currentstatus: The current ID manager status. Valid for hm_getvalue query only.; Type: string
definedentity: True if the entity is defined, false otherwise.; Type: Boolean
entitytypes: List of entity types existing in the module. Valid for hm_getvalue query only.; Type: string array
excludeshowhidestate: The show (true)/hide (false) state of excluded entity types in the ID manager. Valid for hm_getvalue query only.; Type: Boolean
exclusive: The type of exclusive ID ranges. Valid for hm_getvalue query only.; Type: integer
hasconflicts: True or false if there are any conflict IDs. Valid for hm_getvalue query only.
hashidestate: True or false if there is a hide state on the submodel or excluded entities. Valid for hm_getvalue query only.
haslocked: True or false if there are any locked IDs. Valid for hm_getvalue query only.
hasoffset: True or false if there are any offset IDs. Valid for hm_getvalue query only.
hasoverflows: True or false if there are any overflow IDs. Valid for hm_getvalue query only.
hasreserved: True or false if there are any reserved IDs. Valid for hm_getvalue query only.
HW_CID: List of component IDs owned by the module.; Type: unsigned integer
HW_CID_OFFSET: The component ID offset assigned to a sibling part instance.; Type: unsigned integer
HW_Material: List of material names assigned to components or properties of the module.; Type: string
HW_MID: List of material IDs assigned to components or properties of the module.; Type: unsigned integer
HW_PID: List of property IDs assigned to components of the module.; Type: unsigned integer
HW_Thickness: List of property thicknesses assigned to components of the module.; Type: double
id: The ID of the entity.; Type: unsigned integer
idlist: The list of internal IDs. If row=<entity_type> is specified, this will return only the specific entity type in the model. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will return the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: unsigned integer
idmanagerstatus: The ID manager status. Valid for hm_getvalue query only.; Type: string array
idsoverflowoptions: List of ID manager overflow options. Valid for hm_getvalue query only.; Type: string array
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
instance_id: The ID of the instance of the module.; Type: integer
internalid: The ID of the entity.; Type: unsigned integer
is_positioned: 0 - Has a default position.; 1 - Has a non-default position; Type: Boolean
is_root: 0 - Is not the root of the hierarchy; 1 - Is the root of the hierarchy; Type: Boolean
isshapeaiencoded: Indicates whether the representation of module occurrence has shapeAI encode signatures set or not.; Type: Boolean
library_revision: If the prototype is stored in the Part Library, this is the library revision, prototype UDM ID, major revision and study revision. Valid for hm_getvalue query only.; Type: string
library_udm_id: If prototype UDM ID stored in the current Part Library. Valid for hm_getvalue query only.; Type: string
lockedids: The list of locked IDs. row=<entity_type> must be specified. If column=<idpool_number> is specified, this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer array
lockfeids: To set locked entity solver IDs when importing from CSV.
major_revision: The prototype major revision as PDM metadata.; Type: string
max: The max of the ID range. If row=<entity_type> is specified, this will be for the specific entity type in the module. Valid for hm_getvalue query only.; Type: integer
maxid: The maximum ID occupied. If row=<entity_type> is specified, this will be for the specific entity type in the module. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer
min: The min of the ID range. If row=<entity_type> is specified, this will be for the specific entity type in the module. Valid for hm_getvalue query only.; Type: integer
minid: The minimum ID occupied. If row=<entity_type> is specified, this will be for the specific entity type in the module. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer
moduleid: The module ID of the entity.; Type: integer
module_triple_dxyz1, module_triple_dxyz2, module_triple_dxyz3, module_triple_xyz0: These are all triples, corresponding to the 4 rows of the transformation matrix for the module. Valid for hm_getvalue query only.; Type: triple double
name: The name of the entity.; Type: string
newidoptions: List of ID manager new ID options. Valid for hm_getvalue query only.; Type: string array
numberofchildren: The number of recursive children of the module. Valid for hm_getvalue query only.; Type: integer
numberofconflicts: The number of conflict IDs. If row=<entity_type> is specified, this will be for the specific entity type in the module. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer
numberofentities: The number of entities in the module. If row=<entity_type> is specified, this will be for the specific entity type in the module. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will be for the specific entity type and ID pool. Valid for hm_getvalue query only. Type: integer
numberoflockedids: The number of locked IDs for an entity type in an module. row=<entity_type> must be specified. If column=<idpool_number> is specified, this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer
numberofoverflow: The number of overflow IDs. If row=<entity_type> is specified, this will be for the specific entity type in the module. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer
numberofreservedids: The number of reserved IDs. row=<entity_type> must be specified. If column=<idpool_number> is specified, this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer
offset: The offset. row=<entity_type> must be specified. If column=<idpool_number> is specified, this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer
outputsuppressed: Returns non-zero if the entity is set "do not export", 0 otherwise.; Type: integer
overflowids: The list of overflow IDs (integer array). If row=<entity_type> is specified, this will be for the specific entity type in the module. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer array
parent: The parent of the module. Valid for hm_getvalue query only.; Type: integer
parentid: The parent of the module. Valid for hm_getvalue query only.; Type: integer
PDM_ID: List of IDs as PDM metadata.; Type: integer
PDM_Material: List of material names as PDM metadata.; Type: string
PDM_MeshFlag: List of mesh flags as PDM metadata.; Type: string
PDM_MID: List of material IDs as PDM metadata.; Type: integer
PDM_PartNumber: List of part numbers as PDM metadata.; Type: string
PDM_PID: List of property IDs as PDM metadata.; Generally formatted as a list of 4 values: <Property ID>, ?<Instance Increment>?, ?<Component Increment>?, ?<Component Offset>?; Type: integer
PDM_Revision: List of revisions as PDM metadata.; Type: integer
PDM_Thickness: List of property thicknesses as PDM metadata.; Type: double
poolid: The pool number of the entity.; Type: integer
poolname: The pool name of the entity.; Type: string
prototype_id: The ID of the prototype module if the specified module is an occurrence; If a prototype, this is just its own ID.Valid for hm_getvalue query only.; Type: integer
prototype_instance_count: The number of instances created for the prototype. If an occurrence, returns 0.; Type: integer
range_offset: The ID range offset.; Type: integer
releaseidsconflictwithreserves: Release the list of reserved IDs. row=<entity_type> must be specified. If column=<idpool_number> is specified, this will be for the specific entity type and ID pool. Type: integer array
releasereservedids: The list of release reserved IDs. row=<entity_type> must be specified. If column=<idpool_number> is specified, this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer array
rep_comment: The comment on the representation.; Type: string
rep_filename: The full path and file name of an occurrence. Returns empty for prototypes and occurrences without a file.; Type: string
rep_name: The name of the representation as shown in the Part Browser "Representation" column. Valid for hm_getvalue only.; Type: string
rep_type: The type of occurrence. Returns N/A for prototypes and occurrences without a type.; Type: string
reservedids: The list of reserved IDs. row=<entity_type> must be specified. If column=<idpool_number> is specified, this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer array
reserveidoption: The ID manager reserve ID option.; Type: string
reserverange: The number of entities in the module. If row=<entity_type> is specified, this will be for the specific entity type in the module. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer
reserverangemax: The max of the reserve range. row=<entity_type> should be specified, this will be for the specific entity type in the module.; Type: integer
reserverangemin: The min of the reserve range. row=<entity_type> should be specified, this will be for the specific entity type in the module.; Type: integer
shapeaiencodingsignaturecad: The shapeAI encoding signature of the CAD representation of the module occurrence.; Type: string
shapeaiencodingsignaturefe: The shapeAI encoding signature of the FE or mesh representation of the module occurrence.; Type: string
showhidestate: The show/hide state on the submodel or excluded entities.
solver_id: The solver ID of the entity.; Type: integer
solverkeyword: The name of the solver keyword.; Type: string
structural_type: The structural type of the module (part or assembly).; Type: string
study_revision: The prototype study revision as PDM metadata.; Type: string
supportedtypesandpools: The list of types and pool numbers which are supported by ID Manager. The return format is {-1 1 -2 3 …} where a negative number is the entity type while a positive number is the ID pool number. Valid for hm_getvalue query only.; Type: integer array
transformation_id: The ID of the transformation entity.; Type: entity
transformation_matrix: The transformation matrix of the entity.; Only valid for occurrences, returns empty for prototypes.; Type: string
typesandpools: The list of types and pool numbers which are listed in the ID Manager. The return format is {-1 1 -2 3 …} where a negative number is the entity type while a positive number is the ID pool number. Valid for hm_getvalue query only.; Type: integer array
typesandpoolswithreservedids: The list of types and pool numbers which have reserved IDs. The return format is {-1 1 -2 3 …} where a negative number is the entity type while a positive number is the ID pool number. Valid for hm_getvalue query only.; Type: integer array
typesofexclusiveidranges: The types of exclusive ID ranges. Valid for hm_getvalue query only.; Type: integer array
typesofindividualidranges: The types of individual ID ranges. Valid for hm_getvalue query only.; Type: integer array
typeswithreservedids: The list of reserved ID entity types. If row=<entity_type> is specified, this will be for the specific entity type in the module. If column=<idpool_number> is specified, row=<entity_type> must also be specified, and this will be for the specific entity type and ID pool. Valid for hm_getvalue query only.; Type: integer array
udm_id: The ID of the entity in UDM.; Type: string
unique_id: The unique ID of the entity.; Type: string
unsettypesandpools: The list of types and pool numbers which do not have an ID range defined. The return format is {-1 1 -2 3 …} where a negative number is the entity type while a positive number is the ID pool number. Valid for hm_getvalue query only.; Type: integer array
variant_condition: If non-empty, implies that the part is used as a variant in one or multiple part configurations.; Type: string
variant_scope: Along with variant_condition, this is used to describe which part configurations the part belongs to as a variant.; Type: string

Version History

2017.1 - Added new data name rep_name.

2017.2 - Added new data names variant_condition and variant_scope.

2019 - Added new data names idlist, is_positioned, structural_type, supportedtypesandpools, typesandpools, typesandpoolswithreservedids and unsettypesandpools.

2020 - Added new data names color_rgb, HW_CID_OFFSET, instance_id and transformation_id.

2020.1 - Added new data names excludeshowhidestate and solverkeyword.

2021.1 - Added new data names rep_comment, moduleid, poolid, poolname, and solver_id.

2021.2 - Added new data names internalname, isshapeaiencoded, shapeaiencodingsignaturecad, shapeaiencodingsignaturefe, and solvername.