responses
Unless otherwise specified, data names are accessible in level 3 only.
- activesuppressed
- Returns non-zero if the entity is set inactive, 0 otherwise.
- attributesmax
- The number of attributes owned by this entity.
- color
- The 1-64 color of the entity.
- color_rgb
- The RGB color of the entity.
- config
- The configuration of the entity.
- definedentity
- True if the entity is defined, false otherwise.
- expression
- The response expression when response is 8.
- expressiontoggle
- Toggle to turn on/off expression. Valid for hm_getvalue query only.
- id
- The ID of the entity.
- 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.
- isactive
- True if associated with an active exploration. Valid for hm_getvalue query only.
- loadcaseid
- The loadcase ID.
- lowerbound
- The lower bound when config is 4.
- lowerboundtoggle
- Toggle to turn on/off lowerbound. Valid for hm_getvalue query only.
- maximumfrequency
- The frequency upper bound to specify the frequency range for displacement, velocity, acceleration and rotation responses in frequency response analysis.
- minimumfrequency
- The frequency lower bound to specify the frequency range for displacement, velocity, acceleration and rotation responses in frequency response analysis.
- modenumber
- The mode number for frequency response.
- moduleid
- The module ID of the entity.
- name
- The name of the entity.
- objective
- 1 - Minimize
- objectivename
- The objective name when config is 3. Valid for hm_getvalue query only.
- outputsuppressed
- Returns non-zero if the entity is set "do not export", 0 otherwise.
- poolid
- The pool number of the entity.
- poolname
- The pool name of the entity.
- referenceresultpath
- The path of the result file used as a reference for response 11.
- response
- 1 - Mass
- responsecomponent
- The response components associated with the responserequesttype.
- responseid
- Define the response as objective or constraint. Valid for config 3 and 4. Valid for hm_getvalue query only.
- responsename
- The response type name. Valid for hm_getvalue query only.
- responserequesttype
- 1 - Maximum (absolute value)
- setids
- The list of entities referred by the response.
- settype
- The type of entity referred by the response. Valid for hm_getvalue query only.
- solver_id
- The solver ID of the entity.
- solverkeyword
- The name of the solver keyword.
- total
- Allows to define the response on the entire model. Valid for response 1 and 2.
- upperbound
- The upper bound when config is 4.
- upperboundtoggle
- Toggle to turn on/off upperbound. Valid for hm_getvalue query only.
- varname
- The name of the variable. Valid for hm_getvalue query only.
Version History
2020
2020.1 - Added new data names maximumfrequency, minimumfrequency, modenumber and solverkeyword. Added new response values 9, 10 and 11.
2021 - Added new data name referenceresultpath.
2021.1 - Added new response value 12 and updated the list of responserequesttype values. Added new data names moduleid, poolid, poolname, and solver_id.