Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:conditional_statement [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:conditional_statement [2026/02/04 16:38] (current) – wikisysop
@@ Line 1: / Line 1: @@
-\\
+====== Conditional Statement ======
-this command was modelled after the [[visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|for_each]] command in the sense that there is a start (conditional_statement) and an ending event (conditional_statement_end).
+This command was modelled after the [[Visual3D:Documentation:Pipeline:Pipeline_Commands:For_Each_and_End_For_Each|For_Each]] command in the sense that there is a start (Conditional_Statement) and an ending event (Conditional_Statement_End).
-when the pipeline comes to an conditional_statement command, it will evaluate the expression using the same syntax as the [[visual3d:documentation:pipeline:expressions:overview|evaluate_expression]] command. if the expression is true (returns any value other than zero), all of the commands between the conditional_statement and conditional_statement_end commands will be executed. if the expression is false (returns a zero), all the commands that are between the conditional_statement and conditional_statement_end commands will be skipped.
+When the pipeline comes to an Conditional_Statement command, it will evaluate the expression using the same syntax as the [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview|Evaluate_Expression]] command. If the expression is TRUE (returns any value other than zero), all of the commands between the Conditional_Statement and Conditional_Statement_End commands will be executed. If the expression is FALSE (returns a zero), all the commands that are between the Conditional_Statement and Conditional_Statement_End commands will be skipped.
-the iteration_parameter_name is used to distinguish between different conditional_statement commands so that conditional_statement and conditional_statement_end commands can be unambiguously associated with each other.
+==== Pipeline Command ====
+The **Conditional Statement** command can be found in the Pipeline Workshop within the Pipeline Control folder as so:
+<code>
+Conditional_Statement
+/ITERATION_PARAMETER_NAME=
+! /EXPRESSION=
+! /AS_INTEGER=TRUE
+;
-**note:** if there is more than one active file then the conditional_statement command will be skipped. this is because the expression might be true for some files and false for others, leaving visual3d in an ambiguous place.
+Conditional_Statement_End
+/ITERATION_PARAMETER_NAME=
+;
+</code>
+====Command Parameters====
+The following table shows the command parameters and descriptions:
-**note:** this command was previously called the expression_loop. scripts referring to this old command name will still work.
+|**Parameter**   |**Description**|
+|**Iteration Parameter Name**|The name of the parameter that the conditional statement will apply to (defined before command)|
+|**Expression**|Expression for the operation to be applied to the selected signals|
+|**As Integer**|True or False: Expression value is stored as integer|
-===== syntax =====
+==== Pipeline Example: Processing Walking and Running Trials ====
-==== conditional_statement ====
+This script will prompt the user to specify if walking or running trials are being processed. Based on the user's selection, different processing will be completed. In this example, the pipeline parameter TEST will be set to 1 if the condition is Walk, and set to 2 if the condition is Run.
-/iteration_parameter_name=
-/[[visual3d:documentation:pipeline:expressions:overview|expression]]=
-**;**
-==== conditional_statement_end ====
-/iteration_parameter_name=
-**;**
-===== pipeline example =====
-this script will prompt the user to specify if walking or running trials are being processed. based on the user's selection, different processing will be completed. in this example, the pipeline parameter test will be set to 1 if the condition is walk, and set to 2 if the condition is run.
 <code>
-prompt_for_pipeline_parameter_value
+Prompt_For_Pipeline_Parameter_Value
-/pipeline_parameter_name=condition
+/PIPELINE_PARAMETER_NAME=CONDITION
-/prompt=select condition:
+/PROMPT=Select Condition:
-/data_type=string
+/DATA_TYPE=STRING
-/default_value=walk
+/DEFAULT_VALUE=Walk
-/use_possible_values=true
+/USE_POSSIBLE_VALUES=TRUE
-/possible_values=walk+run
+/POSSIBLE_VALUES=Walk+Run
-! /use_units=false
+! /USE_UNITS=FALSE
-! /default_units=
+! /DEFAULT_UNITS=
-! /use_possible_units=false
+! /USE_POSSIBLE_UNITS=FALSE
-! /possible_units=
+! /POSSIBLE_UNITS=
-! /conversions=
+! /CONVERSIONS=
 ;
-conditional_statement
+Conditional_Statement
-/iteration_parameter_name=statement_1
+/ITERATION_PARAMETER_NAME=STATEMENT_1
-/expression= "&::condition&" == "walk"
+/EXPRESSION= "&::CONDITION&" == "WALK"
 ;
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=test
+/PARAMETER_NAME=TEST
-/parameter_value=1
+/PARAMETER_VALUE=1
-! /parameter_value_search_for=
+! /PARAMETER_VALUE_SEARCH_FOR=
-! /parameter_value_replace_with=
+! /PARAMETER_VALUE_REPLACE_WITH=
-! /parameter_value_prefix=
+! /PARAMETER_VALUE_PREFIX=
-! /parameter_value_append=
+! /PARAMETER_VALUE_APPEND=
-! /multi_pass=false
+! /MULTI_PASS=FALSE
 ;
-conditional_statement_end
+Conditional_Statement_End
-/iteration_parameter_name=statement_1
+/ITERATION_PARAMETER_NAME=STATEMENT_1
 ;
-conditional_statement
+Conditional_Statement
-/iteration_parameter_name=statement_2
+/ITERATION_PARAMETER_NAME=STATEMENT_2
-/expression= "&::condition&" == "run"
+/EXPRESSION= "&::CONDITION&" == "RUN"
 ;
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=test
+/PARAMETER_NAME=TEST
-/parameter_value=2
+/PARAMETER_VALUE=2
-! /parameter_value_search_for=
+! /PARAMETER_VALUE_SEARCH_FOR=
-! /parameter_value_replace_with=
+! /PARAMETER_VALUE_REPLACE_WITH=
-! /parameter_value_prefix=
+! /PARAMETER_VALUE_PREFIX=
-! /parameter_value_append=
+! /PARAMETER_VALUE_APPEND=
-! /multi_pass=false
+! /MULTI_PASS=FALSE
 ;
-conditional_statement_end
+Conditional_Statement_End
-/iteration_parameter_name=statement_2
+/ITERATION_PARAMETER_NAME=STATEMENT_2
 ;
 </code>
+====Notes====
+The ITERATION_PARAMETER_NAME is used to distinguish between different Conditional_Statement commands so that Conditional_Statement and Conditional_Statement_End commands can be unambiguously associated with each other.
+**NOTE:** If there is more than one active file then the Conditional_Statement command will be skipped. This is because the expression might be TRUE for some files and FALSE for others, leaving Visual3D in an ambiguous place.
+**NOTE:** This command was previously called the Expression_Loop. Scripts referring to this old command name will still work.