Differences

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

--- visual3d:documentation:pipeline:file_commands:file_close [2024/06/17 18:19] – created sgranger
+++ visual3d:documentation:pipeline:file_commands:file_close [2025/07/22 16:42] (current) – wikisysop
@@ Line 1: / Line 1: @@
+====== File Close ======
+===== Overview =====
+The **File_Close** command is used to close open movement files in the Visual3D workspace. It mirrors the user action **File > Close** from the Visual3D menu but is used programmatically within a pipeline script.
-Close the [[Visual3D:Documentation:Definitions:Active_Files|Active Files]].
+This command is important in batch processing or cleanup workflows, where you may need to:
+  * Close all files before loading a new set
+  * Close only certain files based on their name or tags
+  * Ensure memory or processing space is freed between tasks
+**Important Notes:**
+  * This command does not save any unsaved changes. Any processing, labeling, or metrics not explicitly saved will be lost when the file is closed.
+  * Only movement files can be closed using this command.
+  * Static model files remain open, unless closed using a separate command
+===== Pipeline Command =====
+Below is the standard form of the File_Close command, showing its available parameters.
-This is equivalent to the user interaction under the [[Visual3D:Documentation:Definitions:Active_Files#File_Close|file menu]].
-Note that only the movement files can be active files, so you can only close movement files.
-File_Name can be ALL_FILES, a [[Visual3D:Documentation:Definitions:Tag|TAG]], or a Filename(Wildcards are acceptable)
 <code>
 File_Close
-/File_Name=
+/FILE_NAME=
+! /QUERY=
+! /CLOSE_ASSOCIATED_MODELS=FALSE
 ;
 </code>
-**To close a model use: [[Visual3D:Documentation:Pipeline:Model_Commands:Model_Commands_Overview#Model_Management|Close_Model_File]]**
+===== Command Parameters =====
-===== File Close using Query Parameter =====
-Visual3D Professional Users have an extra Parameter.
+The following table shows the command parameters and descriptions:
-**File_Close**
+|**Parameter**|**Description**|
-/File_Name=
+|**/FILE_NAME=**|Specifies the movement file(s) to be closed. Accepts a full filename, wildcards (e.g., *walk*.c3d), the keyword ALL_FILES, or a list parameter path (e.g., ::FILES)|
-/Query=
+|**! /QUERY=**|Logical expression to filter files based on tags (e.g., Tag1 & NOT Tag2). Works the same as in Select_Active_File.|
-**;**
+|**! /CLOSE_ASSOCIATED_MODELS= FALSE**|If True, closes any models linked to the movement files. Default is FALSE.|
-To accomplish Example_2 below:
-**File_Close**
+===== Dialog =====
-/File_Name=ALL_FILES
-/Query=Tag1 & NOT(Tag2)
-**;**
-===== Example_1 =====
-To close all movement trials containing the string "walk"
+This command does not have a dedicated dialog box. In the Visual3D interface, the equivalent action is navigating to File > Close, which will make open the prompts to ensure that the user is aware that any unsaved progress will be lost.
-**File_Close**
+When executed via pipeline, these prompts do not appear- files are closed immediately and without confirmation.
-/File_Name= *walk*.c3d
-**;**
-===== Example_2 =====
-To close the active files, you need to have an intermediate command.
+===== Examples =====
-Select all files with Tag1 that do not also have Tag2, then close the active files.
+The following examples will go through the use of the File_Close command in the Visual3D application.
-**[[Visual3D:Documentation:Pipeline:File_Commands:Select_Active_File|Select_Active_File]]**
+=== Example 1: Close all trials that contain "walk" in the filename ===
+This example demonstrates how to close all movement files where the filename contains the word "walk".
+<code>
+File_Close
+/FILE_NAME=*walk*.c3d
+!/QUERY=
+!/CLOSE_ASSOCIATED_MODELS=FALSE
+</code>
+=== Example 2: Close only trials with Tag1 and NOT Tag2 ===
+This example demonstrates how to use a tag-based query to selectively close files.
+<code>
+! Step 1- Select all files that are tagged Tag1 but NOT Tag2
+Select_Active_File
 /FILE_NAME=ALL_FILES
-QUERY=Tag1 & NOT(Tag2)
+/QUERY=Tag1 & NOT(Tag2)
-**;**
+;
-**[[Visual3D:Documentation:Pipeline:Pipeline_Commands:Set_Pipeline_Parameter_To_List_Of_Tagged_Files|Set_Pipeline_Parameter_To_List_Of_Tagged_Files]]**
+! Step 2 - Store that selection in a list variable
+Set_Pipeline_Parameter_To_List_Of_Tagged_Files
 /PARAMETER_NAME=FILES
-/TAG_NAME=
+! /TAG_NAME=
-/GET_CURRENT_SELECTED_FILES=true
+/GET_CURRENT_SELECTED_FILES=TRUE
-! /USE_SHORT_FILENAMES=false
+! /USE_SHORT_FILENAMES=FALSE
-**;**
+;
-**File_Close**
+File_Close
 /FILE_NAME=::FILES
-**;**
+;
-\\
+</code>
-\\
-[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]
+----
+[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]