User Tools

Site Tools


visual3d:documentation:pipeline:pipeline_commands:get_pipeline_parameter_index_value

Get Pipeline Parameter Index Value

This pipeline command allows users to access pipeline parameter “array values” by “index”. It is particularly useful alongside the 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:

Get_Pipeline_Parameter_Index_Value
/PARAMETER_NAME=
/PARAMETER_VALUE=
/INDEX=
;

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.

Set_Pipeline_Parameter
/PARAMETER_NAME=running_speed
/PARAMETER_VALUE=10 km/h+12 km/h+14 km/h
;

Set_Pipeline_Parameter
/PARAMETER_NAME=filenames
/PARAMETER_VALUE=fileA + fileB + fileC
;

For_Each
/ITERATION_PARAMETER_NAME=file
/ITERATION_PARAMETER_COUNT_NAME=increment
/ITEMS=::filenames
;
  
   File_Open
   /FILE_NAME=::file
   ;
  
   Get_Pipeline_Parameter_Index_Value
   /PARAMETER_NAME= SCOTT
   /PARAMETER_VALUE=::running_speed
   /INDEX=::increment
   ;

   Assign_Tags_To_Files
   /MOTION_FILE_NAMES=::file
   /TAGS=::SCOTT
   ;
  
End_For_Each
/ITERATION_PARAMETER_NAME=file
;
visual3d/documentation/pipeline/pipeline_commands/get_pipeline_parameter_index_value.txt · Last modified: by wikisysop