responses

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.
2 - General
3 - Objective
4 - Constraint
Type: unsigned integer
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
expression
The response expression when response is 8.
Type: string
expressiontoggle
Toggle to turn on/off expression. Valid for hm_getvalue query only.
Type: integer
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
internalid
The ID of the entity.
Type: unsigned integer
internalname
The internal name of the entity.
Type: string
isactive
True if associated with an active exploration. Valid for hm_getvalue query only.
Type: Boolean
loadcaseid
The loadcase ID.
Type: entity
lowerbound
The lower bound when config is 4.
Type: double
lowerboundtoggle
Toggle to turn on/off lowerbound. Valid for hm_getvalue query only.
Type: Boolean
maximumfrequency
The frequency upper bound to specify the frequency range for displacement, velocity, acceleration and rotation responses in frequency response analysis.
Type: double
measuretype
The type of measure for the Measure response. Valid values are:
Distance Between
Position
Relative Displacement
Relative Angle
Angle Between
Type: string
minimumfrequency
The frequency lower bound to specify the frequency range for displacement, velocity, acceleration and rotation responses in frequency response analysis.
Type: double
modenumber
The mode number for frequency response.
Type: integer
moduleid
The module ID of the entity.
Type: integer
name
The name of the entity.
Type: string
objective
1 - Minimize
2 - Maximize
Type: unsigned integer
objectivename
The objective name when config is 3. Valid for hm_getvalue query only.
Type: string
outputsuppressed
Returns non-zero if the entity is set "do not export", 0 otherwise.
Type: integer
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
referenceresultpath
The path of the result file used as a reference for response 11.
Type: string
response
1 - Mass
2 - Volume
3 - Stress
4 - Force
5 - Displacement
6 - Strain
7 - Rotation
8 - Derived
9 - Velocity
10 - Acceleration
11 - Frequency
12 - Connector
13 - Measure
Type: unsigned integer
responsecomponent
The response components associated with the responserequesttype.
Type: string
responseid
Define the response as objective or constraint. Valid for config 3 and 4. Valid for hm_getvalue query only.
Type: entity
responsename
The response type name. Valid for hm_getvalue query only.
Type: string
responserequesttype
1 - Maximum (absolute value)
2 - First value
3 - Last value
4 - First value min
5 - Last value min
6 - Maximum
7 - Mean
8 - Minimum
Type: string
setids
The list of entities referred by the response.
Type: entity array
settype
The type of entity referred by the response. Valid for hm_getvalue query only.
Type: integer
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
total
Allows to define the response on the entire model. Valid for response 1 and 2.
Type: Boolean
upperbound
The upper bound when config is 4.
Type: double
upperboundtoggle
Toggle to turn on/off upperbound. Valid for hm_getvalue query only.
Type: Boolean
varname
The name of the variable. Valid for hm_getvalue query only.
Type: string

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.

2021.2 - Added new data names internalname, measuretype, and solvername and new response value 13.