hm_entityisdirty
Returns dirtiness status of an entity.
Syntax
hm_entityisdirty entity_type entity_id dirtiness_aspect
Type
HyperMesh Tcl Query Command
Description
An automatic mechanism marks includes/modules dirty (modified) when they or entities belonging to them are changed. They get “cleaned” when exported (for includes) or saved as representations (for modules).
This query returns the dirtiness status of an entity for a specific aspect (currently only “dirty_for_export”).
1 for dirty.
0 for not-dirty.
Inputs
- entity_type
- Currently, only includes and modules are valid entity types.
- entity_id
- The HyperMesh ID of an include or module.
- dirtiness_aspect
- Should always be “dirty_for_export”. Parameter exists to support other aspects in the future.
Examples
Asks whether to include the file with ID 1 is “dirty_for_export”:
hm_entityisdirty includes 1 "dirty_for_export"Errors
Incorrect usage results in a Tcl error. To detect errors, you can use
the catch
command:
if { [ catch {hm_entityisdirty includes 1 “dirty_export”} ] } {
# Handle error
}Version History
2021.2