modelcheckchecks

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
checkentity
The ID of the entity on which the check is to be performed.
Type: unsigned integer
checkvalue
The user input value for a check run.
Type: string
childids
The IDs of the checks within a folder.
Type: unsigned integer
comments
The description/details of the check.
Type: string
concernedids
The IDs of the failed nodes returned by the Incompatible Kinematic Conditions (IKC) check.
Type: entity array
config
The configuration of the entity.
1 - Folder
2 - Check
3 - Tcl check
4 - Generic check
Type: unsigned integer
correctionids
The IDs of the auto corrections applicable for the check.
Type: entity array
defaultcorrection
The default auto correction to be applied to the check.
Type: unsigned integer
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
failedcount
The number of checks failing for a folder.
Type: unsigned integer
failedids
The IDs of the entities failing the check.
Type: unsigned integer array
failedvalues
The failed values obtained for each failed ID of the check. Valid for hm_getvalue query only.
Type: string array
filename
The file in which the check is defined.
Type: string
filterattribute
The attribute on which the filter is applied.
Type: string
filtercriteria
The criteria for filer value comparison, if any.
Type: string
filtersmax
The number of filters applied on the check.
Type: unsigned integer
filtervalue
The value of the attribute to be compared.
Type: string
functionname
The name of the function to run to execute the check.
Type: string
group
The folder under which the check is defined.
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
internalid
The ID of the entity.
Type: unsigned integer
level
The level of the check.
1 - Folder
2 - Error
3 - Warning
4 - Info
Type: unsigned integer
manualcorrection
The manual correction to be applied on the failed entities of the check.
Type: unsigned integer
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
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
priority
The order in which the checks are to be performed.
Type: string
references
The references that are to be checked.
Type: string
referencesmax
The number of references that are to be checked in the check run.
Type: unsigned integer
report
Sets the type of check. A report is generated.
Example: To capture images of duplicate 1D elements, report type is 3.
hm_getvalue modelchecks name="Duplicate 1D Elements" dataname="report"
0 - IDS
1 - CARDIMAGES
2 - VALUES
3 - PLOT
Type: unsigned integer
runstatus
The run status of the check.
Type: integer
runtime
The time taken to run the check.
Type: double
shortname
The short name for the check.
Type: string
solver_id
The solver ID of the entity.
Type: integer
solverkeyword
The name of the solver keyword.
Type: string
status
The status of the check.
0 - Inactive
1 - Active
2 - Deleted
Type: integer
tclfile
The file in which the Tcl check function is defined.
Type: string
userstatus
The status of the check as defined by the user. By default it is determined by the run status of the check.
0 - FAIL
1 - PASS
2 - INFO
Type: string
valueattribute
The attributes on which the value is considered.
Type: string
valuecriteria
The criteria for the values.
Type: string
valuelimit
The limit of the values to be verified.
Type: string
valuesmax
The number of values to be checked.
Type: unsigned integer

Version History

2019

2019.1 - Added new data names failedvalues and userstatus.

2020 - Added new data name color_rgb.

2020.1 - Added new data name solverkeyword.

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