parameters

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
caddimension
The parameter CAD dimensionality:
0 - None
1 - Constant
2 - Length
3 - Angle
Type: unsigned integer
cadfullname
The full name of the parameter in the CAD system.
Type: string
cadsystem
The originating CAD system:
0 - NX 1847 (native reader, Windows only)
1 - CATIA
Type: unsigned integer
cadunits
The CAD system units associated to the parameter:
0 - None
1 - mm
2 - cm
3 - m
4 - in
5 - ft
6 - Degree
7 - Radian
Type: unsigned integer
cardimage
The name of the assigned card image.
Type: string
cardimagetype
The type of the assigned card image.
Type: string
config
The configuration of the entity.
1 - General
2 - CAD
4 - Opti allowables
5 - Opti range
6 - Design variable
7 - Symbol
Type: unsigned integer
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
discrete_dv
The list of discrete values. This is valid when usage is 5.
Type: double array
discrete_dv_count
The number of discrete values. This is valid when usage is 5.
Type: unsigned integer
dvlink
The design variable linking one parameter to another.
Type: entity
dvmode
The design variable type. Valid values are Continuous, Discrete, Categorical.
Type: string
formulalist
The list of entities parameterized in a formula list. Returns [entity_type addition_type clause_type entity_ids].
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
Indicates whether dvlink is active or not.
Type: Boolean
localname
The visible name visible for local parameters. This name may be duplicated for local parameter across different includes. Valid only for LS-DYNA.
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
parameter_opti_allowables_double
The values equal to the number defined. This is applicable when usage is 3 and type is 0.
Type: double
parameter_opti_allowables_double_count
The number of allowable double values. This is applicable when usage is 3 and type is 0.
parameter_opti_allowables_int
The values equal to the number defined. This is applicable when usage is 3 and type is 1.
Type: integer
parameter_opti_allowables_int_count
The number of allowable integer values. This is applicable when usage is 3 and type is 1.
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
qualifierlist
The list of attributes/datanames parameterized. Returns [entity_type attribute_number row_index column_index].
range_double_lower
The lower range of double value. This is applicable when when usage is 4 and type is 0.
range_double_upper
The upper range of double value. This is applicable when when usage is 4 and type is 0.
range_int_levels
The integer value for the of levels between the lower and upper range. This is applicable when when usage is 4 and type is 0 or 1.
range_int_lower
The lower range of integer value. This is applicable when when usage is 4 and type is 1.
range_int_upper
The upper range of integer value. This is applicable when when usage is 4 and type is 1.
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
symbol_quantity
The quantity of a parameter when the usage value is 6.
Type: string
type
The solver dependent type code for the entity.
Type: integer
usage
The usage of the entity.
  • 0 - General
  • 2 - CAD
  • 3 - Discrete
  • 4 - Continuous
  • 5 - Design variable
  • 6 - Symbol
Type: integer
usesexpression
True if expression is used, otherwise false. Valid for hm_getvalue query only.
Type: Boolean
valueexpression
The value of a parameter when when type is 3 or 4.
valuedouble
The value of a parameter when type is 0.
Type: double
valueint
The value of a parameter when type is 1.
Type: integer
valuestring
The value of a parameter when type is 2.
Type: string
varmgrinclude
The flag to enable/disable the parameter entity in the variable manager.
Type: Boolean
varname
The variable name when usage is 5.
Type: string

Version History

2019 - Added new data name localname.

2019.1 - Added new config value 6 and usage value 5. Added new data names dvlink, isactive and varname.

2020 - Added new data names discrete_dv, discrete_dv_count and dvmode.

2021 - Added new data names caddimension, cadfullname, cadsystem and cadunits. Added new config 2.

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

2021.2 - Added the new data names internalname, solvername, symbol_quantity, and varmgrinclude. Added new config value 7 and new usage value 6.