Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_from_for_loop [2024/07/03 17:43] – created sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_from_for_loop [2026/02/19 20:36] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Set_Pipeline_Parameter_From_For_Loop ======
+====== Set Pipeline Parameter From For Loop ======
+The **Set Pipeline Parameter From For Loop** command can be used to create a new pipeline parameter that is used to mimic a traditional for loop.
-Create a pipeline parameter to mimic a traditional for loop.
 Traditional for loops are numerical representations, such as:
@@ Line 10: / Line 9: @@
 This command creates a string expression.
-==== Integer loop ====
+====Pipeline Command====
+The command can be found in the Pipeline Workshop within the Pipeline Control folder as so:
+<code>
+Set_Pipeline_Parameter_From_For_Loop
+/PARAMETER_NAME=
+! /PARAMETER_INDEX_START=
+! /PARAMETER_INDEX_END=
+! /PARAMETER_INDEX_STEP=
+! /PARAMETER_INDEX_TYPE=INTEGER
+;
+</code>
-**Set_Pipeline_Parameter_From_For_Loop**
+====Command Parameters====
+The following table shows the command parameters that can be used to define the command and their descriptions:
+|**Parameter**   |**Description**|
+|**Parameter Name**|Name of the parameter to be set|
+|**Parameter Index Start**|Starting value of the index|
+|**Parameter Index End**|Ending value of the index|
+|**Parameter Index Step**|Size of the step between index values|
+|**Parameter Index Type**|Type of output value (I.e. float, integer)|
+====Example: Integer loop ====
+This example shows how the command can be used to generate an integer loop:
+<code>
+Set_Pipeline_Parameter_From_For_Loop
 /PARAMETER_NAME=INT_VALUES
 /PARAMETER_INDEX_START=1
@@ Line 18: / Line 41: @@
 /PARAMETER_INDEX_STEP=1
 /PARAMETER_INDEX_TYPE=INTEGER
-**;**
+;
+</code>
 on execution the results are
 INT_VALUES = 1+2+3+4+5+6+7+8+9+10
-\\
-==== Float loop ====
-**Set_Pipeline_Parameter_From_For_Loop**
+====Example: Float loop ====
+The following code shows how the command can be used to create a float loop:
+<code>
+Set_Pipeline_Parameter_From_For_Loop
 /PARAMETER_NAME=FLOAT_VALUES
 /PARAMETER_INDEX_START=0
@@ Line 33: / Line 59: @@
 /PARAMETER_INDEX_STEP=0.5
 /PARAMETER_INDEX_TYPE=FLOAT
-**;**
+;
+</code>
 FLOAT_VALUES = 0.000000+0.500000+1.000000+1.500000+2.000000+2.500000+3.000000+3.500000+4.000000+4.500000+5.000000
-==== Expressions ====
+====Example: Defining Command with Expressions ====
 The start, end and step parameters will accept expressions.
@@ Line 42: / Line 70: @@
 Create 3 global metric signals:
+<code>
 Metric_Explicit
 /RESULT_METRIC_NAME=GLOBAL::START
 /RESULT_METRIC_FOLDER=COUNTER
 /METRIC_VALUE=0
-**;**
+;
 Metric_Explicit
 /RESULT_METRIC_NAME=GLOBAL::END
 RESULT_METRIC_FOLDER=COUNTER
 /METRIC_VALUE=5
-**;**
+;
 Metric_Explicit
 /RESULT_METRIC_NAME=GLOBAL::STEP
 /RESULT_METRIC_FOLDER=COUNTER
 /METRIC_VALUE=1
-**;**
+;
-**Set_Pipeline_Parameter_From_For_Loop**
+Set_Pipeline_Parameter_From_For_Loop
 /PARAMETER_NAME=FLOAT_VALS
 /PARAMETER_INDEX_START=GLOBAL::METRIC::COUNTER::START
@@ Line 63: / Line 95: @@
 /PARAMETER_INDEX_STEP=GLOBAL::METRIC::COUNTER::STEP
 /PARAMETER_INDEX_TYPE=FLOAT
-**;**
+;
+</code>
 FLOAT_VALS = 0.000000+1.000000+2.000000+3.000000+4.000000+5.000000