Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:get_pipeline_parameter_index_value [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:get_pipeline_parameter_index_value [2026/04/30 14:04] (current) – wikisysop
@@ Line 1: / Line 1: @@
-description: allow accessing pipeline parameter "array values" by "index".
+====== Get Pipeline Parameter Index Value ======
+This pipeline command allows users to access pipeline parameter "array values" by "index". It is particularly useful alongside the [[visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|For_Each and End_For_Each]] commands to iterate through a second item list.
+===== Command Syntax =====
+The command can be found in the Pipeline Workshop within the Pipeline Control folder as so:
 <code>
-get_pipeline_parameter_index_value
+Get_Pipeline_Parameter_Index_Value
-/parameter_name=
+/PARAMETER_NAME=
-/parameter_value=
+/PARAMETER_VALUE=
-/index=
+/INDEX=
 ;
 </code>
-====== example ======
+===== Command Parameters =====
+The following table shows the command parameters that can be used to define the command and their descriptions:
+^ Parameter ^ Description ^
+| **Parameter Name** | A pipeline parameter name to allow access to the indexed item.|
+| **Parameter Value** | A list of items within which to index. |
+| **Index** | The index at which to pull an item from Parameter Value. |
+===== Example =====
+This example demonstrates how to iterate through two matched lists, running_speed and filenames, and then tag each file with the corresponding running speed.
 <code>
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=running_speed
+/PARAMETER_NAME=running_speed
-/parameter_value=10 km/h+12 km/h+14 km/h
+/PARAMETER_VALUE=10 km/h+12 km/h+14 km/h
 ;
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=filenames
+/PARAMETER_NAME=filenames
-/parameter_value=filea + fileb + filec
+/PARAMETER_VALUE=fileA + fileB + fileC
 ;
-for_each
+For_Each
-/iteration_parameter_name=file
+/ITERATION_PARAMETER_NAME=file
-/iteration_parameter_count_name=increment
+/ITERATION_PARAMETER_COUNT_NAME=increment
-/items=filenames
+/ITEMS=::filenames
 ;
-   file_open
+   File_Open
-   /file_name=::file
+   /FILE_NAME=::file
    ;
-   get_pipeline_parameter_index_value
+   Get_Pipeline_Parameter_Index_Value
-   /parameter_name= scott
+   /PARAMETER_NAME= SCOTT
-   /parameter_value=::running_speed
+   /PARAMETER_VALUE=::running_speed
-   /index=::increment
+   /INDEX=::increment
    ;
-   assign_tags_to_files
+   Assign_Tags_To_Files
-   /motion_file_names=::file
+   /MOTION_FILE_NAMES=::file
-   /tags=::scott
+   /TAGS=::SCOTT
    ;
-end_for_each
+End_For_Each
-/iteration_parameter_name=file
+/ITERATION_PARAMETER_NAME=file
 ;
 </code>