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.

Traditional for loops are numerical representations, such as:

For i=1 to 10 step1 Visual3D's For_Each loop are string entries that are specified explicitly by the user.

This command creates a string expression.

Pipeline Command

The command can be found in the Pipeline Workshop within the Pipeline Control folder as so:

Set_Pipeline_Parameter_From_For_Loop
/PARAMETER_NAME=
! /PARAMETER_INDEX_START=
! /PARAMETER_INDEX_END=
! /PARAMETER_INDEX_STEP=
! /PARAMETER_INDEX_TYPE=INTEGER
;

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:

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

Example: Float loop

The following code shows how the command can be used to create a float loop:

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
;

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.

Create 3 global metric signals:

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
/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