Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_to_folder_path [2024/06/26 20:06] – removed sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_to_folder_path [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
+====== Set Pipeline Parameter To Folder Path ======
+The command Set_Pipeline_Parameter_To_Folder_Path will set a pipeline parameter to be the Folder path. The command is below.
+Set_Pipeline_Parameter_To_Folder_Path
+/PARAMETER_NAME= the parameter name
+! /PARAMETER_VALUE=VISUAL3D_DEFAULT_DATA_FOLDER the Visual 3D data folder
+! /PARAMETER_VALUE_MOTION_FILE= the motion file
+! /PARAMETER_VALUE_SEARCH_FOR= the value to search for
+! /PARAMETER_VALUE_REPLACE_WITH= the value to replace with
+! /PARAMETER_VALUE_APPEND= value to append
+If the **/Parameter_Value** is left blank, the user is prompted for the folder. For example, these commands will prompt the user for the folder path, which could then be used to open all of the C3D files in a folder as follows.
+<code>
+Set_Pipeline_Parameter_To_Folder_Path
+/PARAMETER_NAME=FOLDER
+/PARAMETER_VALUE=
+! /PARAMETER_VALUE_SEARCH_FOR=
+! /PARAMETER_VALUE_REPLACE_WITH=
+! /PARAMETER_VALUE_APPEND=
+;
+Open_File
+/File_Name=::FOLDER&*.c3d
+;
+</code>
+==== Version 5 ====
+In version 5 a new parameter **/PARAMETER_VALUE_MOTION_FILE** was added.
+If the **/PARAMETER_VALUE** is empty, but the **/PARAMETER_VALUE_MOTION_FILE** has a string, this string is assumed to be one of the motion files in the workspace. If the motion file is found, its path is used for the folder path.
+<code>
+Set_Pipeline_Parameter_To_Folder_Path
+/PARAMETER_NAME=FOLDER
+/PARAMETER_VALUE=
+/PARAMETER_VALUE_MOTION_FILE=*walk01.c3d
+! /PARAMETER_VALUE_SEARCH_FOR=
+! /PARAMETER_VALUE_REPLACE_WITH=
+! /PARAMETER_VALUE_APPEND=
+;
+</code>
+If the **/PARAMETER_VALUE_MOTION_FILE=*.cmo** the folder path for the current cmo file is used for the folder path.
+<code>
+Set_Pipeline_Parameter_To_Folder_Path
+/PARAMETER_NAME=FOLDER
+/PARAMETER_VALUE=
+/PARAMETER_VALUE_MOTION_FILE=*.cmo
+! /PARAMETER_VALUE_SEARCH_FOR=
+! /PARAMETER_VALUE_REPLACE_WITH=
+! /PARAMETER_VALUE_APPEND=
+;
+</code>
+==== Default Folders ====
+There are four default folders that are set in the program options that can be referred to:
+VISUAL3D_DEFAULT_DATA_FOLDER
+VISUAL3D_DEFAULT_REPORT_FOLDER
+VISUAL3D_DEFAULT_MODEL_FOLDER
+VISUAL3D_DEFAULT_PIPELINE_FOLDER
+MOST_RECENT_VISUAL3D_PIPELINE_FOLDER
+MOST_RECENT_VISUAL3D_FILE_OPEN_FOLDER
+For example, to refer to the default data folder:
+<code>
+Set_Pipeline_Parameter_To_Folder_Path
+/PARAMETER_NAME=
+! /PARAMETER_VALUE=VISUAL3D_DEFAULT_DATA_FOLDER
+! /PARAMETER_VALUE_MOTION_FILE=
+! /PARAMETER_VALUE_SEARCH_FOR=
+! /PARAMETER_VALUE_REPLACE_WITH=
+! /PARAMETER_VALUE_APPEND=
+;
+</code>
+For example, to refer to the default report template folder:
+<code>
+Set_Pipeline_Parameter_To_Folder_Path
+/PARAMETER_NAME=FOLDER
+/PARAMETER_VALUE=VISUAL3D_DEFAULT_REPORT_FOLDER
+/PARAMETER_VALUE_MOTION_FILE=
+! /PARAMETER_VALUE_SEARCH_FOR=
+! /PARAMETER_VALUE_REPLACE_WITH=
+! /PARAMETER_VALUE_APPEND=
+;
+</code>
+==== Example ====
+[[Visual3D:Documentation:Pipeline:File_Commands:Export_Data_To_ASCII_File#Example_1_:_File_Export_of_multiple_files|Export multiple files]]