*entitysetdirty

Updates dirtiness status of an entity.

Syntax

*entitysetdirty entity_type entity_id dirtiness_aspect dirty_flag ?options?

Type

HyperMesh Tcl Modify 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 command allows the manual manipulation of their dirty status to override the automatic mechanism if it is needed by a specific work-flow or user request.

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.
dirty_flag: 0 - Clears the dirty flag, making the entity “clean.”; 1 - Sets the dirty flag, marking the entity as “modified.”
?options?: Optional list of inputs passed as a comma separated string. Not utilized currently; exists for future use.

Examples

“Clean” include file with ID 1.

*entitysetdirty includes 1 "dirty_for_export" 0

Errors

Incorrect usage results in a Tcl error. To detect errors, you can use the catch command:

if { [ catch {*entitysetdirty mats 1 “dirty_for_export” 0} ] } {
   # Handle error
}

Version History

2021.2