Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_from_for_loop [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_from_for_loop [2026/02/19 20:36] (current) – wikisysop
@@ Line 1: / Line 1: @@
-create a pipeline parameter to mimic a traditional 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.
-traditional for loops are numerical representations, such as:
+Traditional for loops are numerical representations, such as:
-for i=1 to 10 step1
+For i=1 to 10 step1
-visual3d's for_each loop are string entries that are specified explicitly by the user.
+Visual3D's For_Each loop are string entries that are specified explicitly by the user.
-this command creates a string expression.
+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>
+====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
+/PARAMETER_INDEX_END=10
+/PARAMETER_INDEX_STEP=1
+/PARAMETER_INDEX_TYPE=INTEGER
+;
+</code>
-**set_pipeline_parameter_from_for_loop**
-/parameter_name=int_values
-/parameter_index_start=1
-/parameter_index_end=10
-/parameter_index_step=1
-/parameter_index_type=integer
-**;**
 on execution the results are
-int_values = 1+2+3+4+5+6+7+8+9+10
+INT_VALUES = 1+2+3+4+5+6+7+8+9+10
-\\
+====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
+/PARAMETER_INDEX_END=5
+/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
+====Example: Defining Command with Expressions ====
+The start, end and step parameters will accept expressions.
-===== float loop =====
+Create 3 global metric signals:
-**set_pipeline_parameter_from_for_loop**
+<code>
-/parameter_name=float_values
+Metric_Explicit
-/parameter_index_start=0
+/RESULT_METRIC_NAME=GLOBAL::START
-/parameter_index_end=5
+/RESULT_METRIC_FOLDER=COUNTER
-/parameter_index_step=0.5
+/METRIC_VALUE=0
-/parameter_index_type=float
+;
-**;**
-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 =====
+Metric_Explicit
+/RESULT_METRIC_NAME=GLOBAL::END
+RESULT_METRIC_FOLDER=COUNTER
+/METRIC_VALUE=5
+;
-the start, end and step parameters will accept expressions.
+Metric_Explicit
+/RESULT_METRIC_NAME=GLOBAL::STEP
+/RESULT_METRIC_FOLDER=COUNTER
+/METRIC_VALUE=1
+;
-create 3 global metric signals:
+Set_Pipeline_Parameter_From_For_Loop
+/PARAMETER_NAME=FLOAT_VALS
+/PARAMETER_INDEX_START=GLOBAL::METRIC::COUNTER::START
+/PARAMETER_INDEX_END=GLOBAL::METRIC::COUNTER::END
+/PARAMETER_INDEX_STEP=GLOBAL::METRIC::COUNTER::STEP
+/PARAMETER_INDEX_TYPE=FLOAT
+;
+</code>
-metric_explicit
+FLOAT_VALS = 0.000000+1.000000+2.000000+3.000000+4.000000+5.000000
-/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**
-/parameter_name=float_vals
-/parameter_index_start=global::metric::counter::start
-/parameter_index_end=global::metric::counter::end
-/parameter_index_step=global::metric::counter::step
-/parameter_index_type=float
-**;**
-float_vals = 0.000000+1.000000+2.000000+3.000000+4.000000+5.000000