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
connector_filter
A filter for the displayed granular entities of the subsystem.
0 - All
1 - Non-zero only
Type: unsigned integer
connectors_attachment
The attachments that are organized in the subsystem.
Type: entity array
connectors_general
The general connectors that are organized in the subsystem.
Type: entity array
connectors_subsystem
The subsystem connectors that are organized in the subsystem.
Type: entity array
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
granular_filter
A filter for the displayed granular entities (nodes, elems, loads, systs, vectors, beamsects) of the subsystem:
0 - All
1 - Non-zero only
Type: unsigned integer
granular_filter_beamsections
The beamsections that exist as contents of the subsystem.
Type: entity array
granular_filter_elements
The elements that exist as contents of the subsystem.
Type: entity array
granular_filter_loads
The loads that exist as contents of the subsystem.
Type: entity array
granular_filter_nodes
The nodes that exist as contents of the subsystem.
Type: entity array
granular_filter_systems
The systems that exist as contents of the subsystem.
Type: entity array
granular_filter_vectors
The vectors that exist as contents of the subsystem.
Type: entity array
granular_mode
A filter for the displayed granular entities (nodes, elems, loads, systs, vectors, beamsects) of the subsystem:
-2 - Off
-1 - Shared
1 - Missing
2 - Additional
Type: unsigned integer
granular_mode_beamsections
The beamsections that exist as contents of the subsystem, filtered by granular_mode.
Type: entity array
granular_mode_elements
The elements that exist as contents of the subsystem, filtered by granular_mode.
Type: entity array
granular_mode_loads
The loads that exist as contents of the subsystem, filtered by granular_mode.
Type: entity array
granular_mode_nodes
The nodes that exist as contents of the subsystem, filtered by granular_mode.
Type: entity array
granular_mode_systems
The systems that exist as contents of the subsystem, filtered by granular_mode.
Type: entity array
granular_mode_vectors
The vectors that exist as contents of the subsystem, filtered by granular_mode.
Type: entity array
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
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
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
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
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