Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:signal_commands:delete_folder [2024/06/18 13:33] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:delete_folder [2026/09/09 18:43] (current) – Initial page. richard
@@ Line 1: / Line 1: @@
-Under Construction...
+====== Delete Folder ======
+The Delete_Folder command allows users to delete specific folders of signals or metrics from the [[visual3d:documentation:visual3d_signal_types:data_tree|data tree]].
+===== Pipeline Command =====
+The Delete_Folder command is located in the pipeline workshop's Signal/Data Management folder.
+<code>
+Delete_Folder
+/SIGNAL_TYPES=
+/FOLDER=
+! /REMOVE_FROM_RECALC_PIPELINE=FALSE
+;
+</code>
+===== Command Parameters =====
+^ Parameter ^ Description ^
+| Signal Types | The [[visual3d:documentation:pipeline:general_information:signal_types|signal type]] to work with. |
+| Folder | The specific [[visual3d:documentation:pipeline:general_information:signal_folder|folder(s)]] to be deleted. |
+| Remove from Recalc pipeline | If true, then the signals contained in the deleted folder will also be removed from the [[visual3d:documentation:pipeline:general_information:recalc_pipeline|Recalc pipeline]]. Default value is false. |
+===== Example: Remove all Link_Model_Based items =====
+This example demonstrates how to remove all [[visual3d:documentation:visual3d_signal_types:link_model_based_data_type|LINK_MODEL_BASED]] items from the workspace and the Recalc pipeline.
+<code>
+Delete_Folder
+/SIGNAL_TYPES=LINK_MODEL_BASED+LINK_MODEL_BASED
+/FOLDER=ORIGINAL+PROCESSED
+/REMOVE_FROM_RECALC_PIPELINE=TRUE
+;
+</code>
+After running this command, all ORIGINAL and PROCESSED Link_Model_Based signals will be removed from the workspace and the corresponding [[visual3d:documentation:pipeline:model_based_data_commands:compute_model_based_data|Compute_Model_Based_Data]] commands will be removed from the Recalc pipeline.