Differences

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

--- visual3d:documentation:pipeline:file_commands:exit_workspace [2024/07/17 15:45] – created sgranger
+++ visual3d:documentation:pipeline:file_commands:exit_workspace [2025/07/08 18:25] (current) – wikisysop
@@ Line 1: / Line 1: @@
 ====== Exit Workspace ======
-Exit the Visual3D Workspace
+===== Overview =====
+The **Exit_Workspace** command is used to close the Visual3D application. It is commonly used as the final step in batch processing pipelines, especially when Visual3D needs to be shut down after executing a series of commands, or when preparing to reload the application with a different dataset.
+  * This command is located in the **File Management** folder within the pipeline interface.
+  * The workspace is not saved automatically when this command is executed, therefore any changes must explicitly saved before using.
+===== Pipeline Command =====
+The command below is as seen on the Visual3D application, there are no parameters as this is standalone command that cannot be modified.
+<code>
+Exit Workspace
+;
+</code>
+===== Command Parameters + Dialog =====
+No dialog box or customization options are available. It simply exits the Visual3D application.
+===== Examples =====
+The following example will go through the use of the Exit_Workspace command in the Visual3D application.
+==== Example 1: Save a File after applying Gait Events, then exit Visual3D ====
+This pipeline demonstrates how to use **Exit_Workspace** as the final step after loading a file, processing it with automatic gait events, saving the changes to a new CMZ file and then exiting the application.
+Step 1 is to open the Visual3D application and execute the first command which will open a CMZ file of your choice, the path must be entered into the /FILE_NAME parameter. Make sure to choose a file which does not contain automatically detected gait events yet.
+<code>
+File_Open
+/FILE_NAME="%::ROOTFOLDER&data_files\Engine_Test\CMZs\Sub04_Workspace"
+! /FILE_PATH=
+! /SEARCH_SUBFOLDERS=FALSE
+! /SUFFIX=
+! /SET_PROMPT=File_Open
+! /ON_FILE_NOT_FOUND=PROMPT
+! /FILE_TYPES_ON_PROMPT=
+;
+</code>
+Step 2 is to execute the "Automatic Gait Events" command in order to apply these detected events to the data. This will modify characteristics of the workspace, therefore it will have to be saved as a separate file under a different name.
+<code>
+Automatic_Gait_Events
+! /FRAME_WINDOW=8
+! /USE_TPR=TRUE
+! /TPR_EVENT_INSTANCE=1
+;
+</code>
+Step 3 is to execute the File Save As command to save this file with the automatically detected gait events. The path of the export must be entered into the /FILE_NAME parameter.
+<code>
+File_Save_As
+/FILE_NAME= "&::ROOTFOLDER&CURRENT_RESULTS\Engine_Test\Sub04_Workspace_with_GaitEvents.cmz"
+! /FOLDER=
+! /SET_PROMPT=Save CMZ file as
+! /SAVE_EMBEDDED_GRAPHICS=FALSE
+! /CREATE_FOLDER_PATH=FALSE
+;
+</code>
+Step 4 is to execute the File_New command in order to make sure the workspace has been cleared and no leftover data is available.
+<code>
+File_New
+;
+</code>
+Step 5, the final step, is to use the command which this page is based on, Exit_Workspace, to close the Visual3D application.
 <code>
 Exit_Workspace
 ;
 </code>
-\\
+----
 [[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]