includefiles
- attributesmax
- The number of attributes owned by this entity.
- children
- Recursive list of children include IDs. Valid for hm_getvalue query only.
- childrenids
- Recursive list of children include IDs. Valid for hm_getvalue query only.
- 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 include. 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.
- 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 include. 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.
- correctoptions
- List of ID manager correction options. Valid for hm_getvalue query only.
- currentcorrectoption
- The current ID manager correction option.
- currentnewidoption
- The current ID manager new ID option.
- currentstatus
- The current ID manager status. Valid for hm_getvalue query only.
- definedentity
- True if the entity is defined, false otherwise.
- dirty_flag_for_export
- Is true when:
- displayed_status
- The display status. Valid for hm_getvalue query only.
- entitytypes
- List of entity types existing in the include. Valid for hm_getvalue query only.
- exclusive
- The type of exclusive ID ranges. Valid for hm_getvalue query only.
- flag1
- Solver flag 1. Valid for hm_getvalue query only.
- flag2
- Solver flag 2. Valid for hm_getvalue query only.
- fullname
- The full name/path of the include. The path may be absolute or relative depending on how it is defined. Valid for hm_getvalue query only.
- 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.
- id
- The ID of the entity.
- 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.
- idmanagerstatus
- The ID manager status. Valid for hm_getvalue query only.
- idsoverflowoptions
- List of ID manager overflow options. Valid for hm_getvalue query only.
- include
- The ID of the include file the entity is organized in.
- includeid
- The ID of the include file the entity is organized in.
- internalid
- The ID of the entity.
- lockedidlist
- The list of locked IDs as internal 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.
- lockeids
- 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 hm_getvalue query only.
- lockfeids
- To set locked entity solver IDs when importing from CSV.
- max
- The max of the ID range. If row=<entity_type> is specified, this will be for the specific entity type in the include. Valid for hm_getvalue query only.
- maxid
- The maximum ID occupied. If row=<entity_type> is specified, this will be for the specific entity type in the include. 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 forhm_getvalue query only.
- min
- The min of the ID range. If row=<entity_type> is specified, this will be for the specific entity type in the include. Valid for hm_getvalue query only.
- minid
- The minimum ID occupied. If row=<entity_type> is specified, this will be for the specific entity type in the include. 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.
- moduleid
- The module ID of the entity.
- newidoptions
- List of ID manager new ID options. Valid for hm_getvalue query only.
- numberofchildren
- The number of recursive children of the include. Valid for hm_getvalue query only.
- numberofconflicts
- The number of conflict IDs. If row=<entity_type> is specified, this will be for the specific entity type in the include. 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.
- numberofentities
- The number of entities in the include. If row=<entity_type> is specified, this will be for the specific entity type in the include. 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.
- numberoflockedids
- The number of locked IDs for an entity type in an include. 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.
- numberofoverflow
- The number of overflow IDs. If row=<entity_type> is specified, this will be for the specific entity type in the include. 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.
- numberofreservedids
- The number of reserved IDs (integer). 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.
- 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.
- overflowids
- The list of overflow IDs. If row=<entity_type> is specified, this will be for the specific entity type in the include. 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.
- parent
- The parent of the include. Valid for hm_getvalue query only.
- parentid
- The parent of the include. Valid for hm_getvalue query only.
- poolid
- The pool number of the entity.
- poolname
- The pool name of the entity.
- range_offset
- The ID range offset.
- 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.
- 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.
- reserveidoption
- The ID manager reserve ID option.
- 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.
- reserverange
- The number of entities in the include. If row=<entity_type> is specified, this will be for the specific entity type in the include. 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.
- reserverangemax
- The max of the reserve range. row=<entity_type> should be specified, this will be for the specific entity type in the include.
- reserverangemin
- The min of the reserve range. row=<entity_type> should be specified, this will be for the specific entity type in the include.
- shortname
- The short name of the include (name without path). Valid for hm_getvalue query only.
- showhidestate
- The show/hide state on the submodel or excluded entities.
- solver_id
- The solver ID of the entity.
- solverkeyword
- The name of the solver keyword.
- 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.
- 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.
- 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.
- typesofexclusiveidranges
- The types of exclusive ID ranges. Valid for hm_getvalue query only.
- typesofindividualidranges
- The types of individual ID ranges under the submodel. Valid for hm_getvalue query only.
- typesundersubmodel
- The type list under the submodel with active value on entity type, like idrange definition or entity count on the type. Valid for hm_getvalue query only.
- typeswithreservedids
- The list of reserved ID entity types. If row=<entity_type> is specified, this will be for the specific entity type in the include. 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.
- 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.
- write_protected
- write_protected The write protected or "do not export" state. Valid for hm_getvalue query only.
Version History
2019 - Added new data names idlist, supportedtypesandpools, typesandpools, typesandpoolswithreservedids and unsettypesandpools.
2020 - Added new data name dirty_flag_for_export.
2020.1 - Added new data name solverkeyword.
2021.1 - Added new data names moduleid, poolid, poolname, and solver_id.