Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:pipeline_parameters_example [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:pipeline_parameters_example [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-this example will add a tag to an individual file based on a c3d parameter. in this case, the file will be tagged from the motion system manufacturer. the pipeline pulls this information from the c3d parameter.
+====== Pipeline Parameters Example  ======
+This example will add a TAG to an individual file based on a C3D parameter. In this case, the file will be tagged from the motion system manufacturer. The pipeline pulls this information from the C3D parameter.
 <code>
 !===========================================================
-! add a tag to an individual file based on a c3d parameter.
+! Add a TAG to an individual file based on a C3D parameter.
 !===========================================================
-! get a list of all of the files in the workspace
+! Get a list of all of the files in the workspace
-set_pipeline_parameter_to_list_of_tagged_files
+Set_Pipeline_Parameter_To_List_Of_Tagged_Files
-/parameter_name=files
+/PARAMETER_NAME=FILES
-/tag_name=all_files
+/TAG_NAME=ALL_FILES
-! /get_current_selected_files=false
+! /GET_CURRENT_SELECTED_FILES=false
-! /use_short_filenames=false
+! /USE_SHORT_FILENAMES=false
 ;
-! set up a loop, so that we can treat each file individually
+! Set up a loop, so that we can treat each file individually
-! and assign the the c3d parameter name as a tag
+! and assign the the C3D parameter name as a TAG
-for_each
+For_Each
-/iteration_parameter_name=index
+/ITERATION_PARAMETER_NAME=INDEX
-/items=::files
+/ITEMS=::FILES
 ;
-   ! select the active file from the looping index
+   ! Select the active file from the looping index
-   select_active_file
+   Select_Active_File
-   /file_name=::index
+   /FILE_NAME=::INDEX
-   ! /query=
+   ! /QUERY=
    ;
-   ! set a pipeline parameter from the c3d parameter
+   ! Set a pipeline parameter from the C3D parameter
-   ! in this case, the parameter pulled from the c3d file is the manufacturer name
+   ! In this case, the parameter pulled from the C3D file is the manufacturer name
-   set_pipeline_parameter_to_data_value
+   Set_Pipeline_Parameter_To_Data_Value
-   /parameter_name=test
+   /PARAMETER_NAME=TEST
-   /signal_types=parameters
+   /SIGNAL_TYPES=PARAMETERS
-   /signal_names=company
+   /SIGNAL_NAMES=COMPANY
-   /signal_folder=manufacturer
+   /SIGNAL_FOLDER=MANUFACTURER
-   /signal_components=all_components
+   /SIGNAL_COMPONENTS=ALL_COMPONENTS
    ;
-   ! assign the c3d parameter name as a tag
+   ! Assign the C3D parameter name as a TAG
-   assign_tags_to_file
+   Assign_Tags_To_File
-   /motion_file_names=::index
+   /MOTION_FILE_NAMES=::INDEX
-   ! /query=
+   ! /QUERY=
-   /tags=::test
+   /TAGS=::TEST
    ;
-! end the loop
+! End the loop
-end_for_each
+End_For_Each
-/iteration_parameter_name=index
+/ITERATION_PARAMETER_NAME=INDEX
 ;
 </code>