includefiles

All data names are accessible only via Tcl and not via the template system.

attributesmax: The number of attributes owned by this entity.; Type: unsigned integer
children: Recursive list of children include IDs. Valid for hm_getvalue query only.; Type: integer array
childrenids: Recursive list of children include IDs. Valid for hm_getvalue query only.; Type: integer array
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.; 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 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.; Type: integer array
correctoptions: List of ID manager correction options. 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
dirty_flag_for_export: Is true when:; - An include or any entity inside the include is modified; - Whenever a cross-referenced material or property is modified; This is reset to false if the include is exported. Valid for hm_getvalue query only.; Type: Boolean
displayed_status: The display status. Valid for hm_getvalue query only.; Type: Boolean
entitytypes: List of entity types existing in the include. Valid for hm_getvalue query only.; Type: string array
exclusive: The type of exclusive ID ranges. Valid for hm_getvalue query only.; Type: integer
flag1: Solver flag 1. Valid for hm_getvalue query only.; Type: string
flag2: Solver flag 2. Valid for hm_getvalue query only.; Type: string
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.; Type: string
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.; 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
internalid: The ID of the entity.; Type: unsigned integer
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.; Type: integer array
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 for hm_getvalue query only.; Type: integer array
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.; Type: integer
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 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 include. 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 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.; Type: integer
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 include. 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 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.; Type: integer
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.; Type: integer
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.; Type: integer
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.; 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
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.; Type: integer array
parent: The parent of the include. Valid for hm_getvalue query only.; Type: integer
parentid: The parent of the include. Valid for hm_getvalue query only.; 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
reserveidoption: The ID manager reserve ID option.; 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
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.; 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 include.; 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 include.; Type: integer
shortname: The short name of the include (name without path). Valid for hm_getvalue query only.; Type: string
showhidestate: The show/hide state on the submodel or excluded entities.
solverkeyword: The name of the solver keyword.; 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
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 under the submodel. Valid for hm_getvalue query only.; Type: integer array
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.; 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 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.; Type: integer array
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
write_protected: write_protected The write protected or "do not export" state. Valid for hm_getvalue query only.; Type: Boolean

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.