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 [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-create a pipeline parameter to mimic a traditional for loop.
+====== Set Pipeline Parameter From For Loop ======
-traditional for loops are numerical representations, such as:
+Create a pipeline parameter to mimic a traditional for loop.
-for i=1 to 10 step1
+Traditional for loops are numerical representations, such as:
-visual3d's for_each loop are string entries that are specified explicitly by the user.
-this command creates a string expression.
+For i=1 to 10 step1
+Visual3D's For_Each loop are string entries that are specified explicitly by the user.
-===== integer loop =====
+This command creates a string expression.
-**set_pipeline_parameter_from_for_loop**
+==== Integer loop ====
-/parameter_name=int_values
-/parameter_index_start=1
+**Set_Pipeline_Parameter_From_For_Loop**
-/parameter_index_end=10
+/PARAMETER_NAME=INT_VALUES
-/parameter_index_step=1
+/PARAMETER_INDEX_START=1
-/parameter_index_type=integer
+/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
 \\
-===== float loop =====
+==== Float loop ====
-**set_pipeline_parameter_from_for_loop**
+**Set_Pipeline_Parameter_From_For_Loop**
-/parameter_name=float_values
+/PARAMETER_NAME=FLOAT_VALUES
-/parameter_index_start=0
+/PARAMETER_INDEX_START=0
-/parameter_index_end=5
+/PARAMETER_INDEX_END=5
-/parameter_index_step=0.5
+/PARAMETER_INDEX_STEP=0.5
-/parameter_index_type=float
+/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
+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 =====
+==== Expressions ====
-the start, end and step parameters will accept expressions.
+The start, end and step parameters will accept expressions.
-create 3 global metric signals:
+Create 3 global metric signals:
-metric_explicit
+Metric_Explicit
-/result_metric_name=global::start
+/RESULT_METRIC_NAME=GLOBAL::START
-/result_metric_folder=counter
+/RESULT_METRIC_FOLDER=COUNTER
-/metric_value=0
+/METRIC_VALUE=0
 **;**
-metric_explicit
+Metric_Explicit
-/result_metric_name=global::end
+/RESULT_METRIC_NAME=GLOBAL::END
-result_metric_folder=counter
+RESULT_METRIC_FOLDER=COUNTER
-/metric_value=5
+/METRIC_VALUE=5
 **;**
-metric_explicit
+Metric_Explicit
-/result_metric_name=global::step
+/RESULT_METRIC_NAME=GLOBAL::STEP
-/result_metric_folder=counter
+/RESULT_METRIC_FOLDER=COUNTER
-/metric_value=1
+/METRIC_VALUE=1
 **;**
-**set_pipeline_parameter_from_for_loop**
+**Set_Pipeline_Parameter_From_For_Loop**
-/parameter_name=float_vals
+/PARAMETER_NAME=FLOAT_VALS
-/parameter_index_start=global::metric::counter::start
+/PARAMETER_INDEX_START=GLOBAL::METRIC::COUNTER::START
-/parameter_index_end=global::metric::counter::end
+/PARAMETER_INDEX_END=GLOBAL::METRIC::COUNTER::END
-/parameter_index_step=global::metric::counter::step
+/PARAMETER_INDEX_STEP=GLOBAL::METRIC::COUNTER::STEP
-/parameter_index_type=float
+/PARAMETER_INDEX_TYPE=FLOAT
 **;**
-float_vals = 0.000000+1.000000+2.000000+3.000000+4.000000+5.000000
+FLOAT_VALS = 0.000000+1.000000+2.000000+3.000000+4.000000+5.000000