subsystems

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
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 - Standard subsystem; 2 - Connector subsystem; Type: unsigned integer
definedentity: True if the entity is defined, false otherwise.; Type: Boolean
dirty_flag: An indicator of whether the subsystem contents have been changed since its last representation was realized. Valid for hm_getvalue query only.; Type: unsigned integer
export_file_parentid: The parent of the file that is used for export. Valid for hm_getvalue query only.; Type: unsigned integer
export_filename: The name of the file used for export. Valid for hm_getvalue query only.; Type: string
export_filepath: The location of the file used for export. Valid for hm_getvalue query only.; Type: string
id: The ID of the entity.; Type: unsigned 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
instance: The instance the entity has been created from. Valid for hm_getvalue query only.; Type: entity
internalid: The ID of the entity.; Type: unsigned integer
internalname: The internal name of the entity.; Type: string
isinlibrary: Indicates if the entity is in the currently connected library.; Type: Boolean
library_comment: The comment used to save the entity in the library.; Type: string
library_entityid: The unique identifier used to save the entity in the library.; Type: string
library_name: The name of the library where the entity is saved.; Type: string
library_revision: The library revision of the entity in the library.; Type: string
major_revision: The major revision of the entity in the library.; Type: string
moduleid: The module ID of the entity.; Type: integer
name: The name of the entity.; Type: string
outputsuppressed: Returns non-zero if the entity is set "do not export", 0 otherwise.; Type: integer
parentSubsystem: The parent of the subsystem. Valid for hm_getvalue query only.; Type: entity
poolid: The pool number of the entity.; Type: integer
poolname: The pool name of the entity.; Type: string
rep_alias: The alias/key of the currently active representation. Valid for hm_getvalue query only.; Type: string
rep_filename: The file name of the currently active representation. Valid for hm_getvalue query only.; Type: string
repDefinitionNames: The representation definitions of the subsystem. Valid for hm_getvalue query only.; Type: string array
repDefinitionNamesSaved: The representation definitions of the subsystem that have been saved. Valid for hm_getvalue query only.; Type: string array
repDefinitionNamesTabularCount: The number of representation definitions of the subsystem. Valid for hm_getvalue query only.; Type: unsigned integer
repRealizationNames: The representation realizations of the subsystem. Valid for hm_getvalue query only.; Type: string array
repRealizationsNamesSaved: The representation realizations of the subsystem that have been saved. Valid for hm_getvalue query only.; Type: string array
repRealizationNamesTabularCount: The number of representation realizations of the subsystem. Valid for hm_getvalue query only.; Type: unsigned integer
repRealizations: The representaiton realizations of the subsystem. Valid for hm_getvalue query only.; Type: entity array
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
study_revision: The study revision of the entity in the library.; Type: string
subsystemslinkedto: The subsystems that the connectors inside are linked to.; Type: entity array
unique_id: The unique ID of the entity.; Type: string

Version History

2020

2020.1 - Added new data name solverkeyword.

2021 - Removed private data names connector_filter, connectors_attachment, connectors_general, connectors_subsystem, granular_filter, granular_filter_beamsections, granular_filter_elements, granular_filter_loads, granular_filter_nodes, granular_filter_systems, granular_filter_vectors, granular_mode, granular_mode_beamsections, granular_mode_elements, granular_mode_loads, granular_mode_nodes, granular_mode_systems, and granular_mode_vectors.

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

2021.2 - Added new data names internalname and solvername.