Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:pipeline_control_commands [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:pipeline_control_commands [2024/09/03 13:26] (current) – wikisysop
@@ Line 1: / Line 1: @@
-an important feature of the pipeline is the ability to create and use pipeline parameters.
+====== Pipeline Control Commands ======
-a pipeline parameter is a way to store a text string for use in pipeline commands. in one sense it is similar to specifying a global variable, such as body weight, that could be used in computations. it is actually much more flexible than that in the pipeline. the visual3d pipeline commands permit multiple entries on a single line, and since the entire line can be represented as a string, a single pipeline parameter can represent multiple signals.
+An important feature of the pipeline is the ability to create and use Pipeline Parameters.
-=== set_pipeline_parameter ===
+A Pipeline PARAMETER is a way to store a text string for use in Pipeline commands. In one sense it is similar to specifying a global variable, such as body weight, that could be used in computations. It is actually much more flexible than that in the pipeline. The Visual3D pipeline commands permit multiple entries on a single line, and since the entire line can be represented as a string, a single PIPELINE PARAMETER can represent multiple signals.
-pipeline parameters can be created in the pipeline and used as variables in other commands in the same pipeline.
+== Set_Pipeline_Parameter ==
-=== set_pipeline_parameter_to_folder_path ===
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter|Set_Pipeline_Parameter]]
-set a pipeline parameter to be the folder path.
+Pipeline parameters can be created in the pipeline and used as variables in other commands in the same pipeline.
-=== set_pipeline_parameter_to_list_of_tagged_files ===
+== Set_Pipeline_Parameter_To_Folder_Path ==
-creates a pipeline parameter containing the names of the tagged files.
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_Folder_Path|Set_Pipeline_Parameter_To_Folder_Path]]
-=== set_pipeline_parameter_to_list_of_files ===
+Set a pipeline parameter to be the Folder path.
-in order to process multiple files it can be useful to identify all of the files in a folder path and assign the names to a pipeline parameter.
+== Set_Pipeline_Parameter_To_List_Of_Tagged_Files ==
-=== set_pipeline_parameter_to_list_of_signal_names ===
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_List_Of_Tagged_Files|Set_Pipeline_Parameter_To_List_Of_Tagged_Files]]
-in order to process multiple signals it can be useful to identify all of the signals of a given type.
+Creates a pipeline parameter containing the names of the TAGGED files.
-=== set_pipeline_parameter_to_data_value ===
+== Set_Pipeline_Parameter_To_List_Of_Files ==
-create a pipeline parameter with the values of a signal
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_List_Of_Files|Set_Pipeline_Parameter_To_List_Of_Files]]
-=== set_pipeline_parameter_from_expression ===
+In order to process multiple files it can be useful to identify all of the files in a folder path and assign the names to a pipeline parameter.
-create a pipeline parameter from an expression
+== Set_Pipeline_Parameter_To_List_Of_Signal_Names ==
-=== set_pipeline_parameter_from_for_loop ===
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_List_Of_Signal_Names|Set_Pipeline_Parameter_To_List_Of_Signal_Names]]
-create a pipeline parameter to mimic a traditional for loop.
+In order to process multiple signals it can be useful to identify all of the signals of a given type.
-=== prompt_for_pipeline_parameter_value ===
+== Set_Pipeline_Parameter_To_Data_Value ==
-prompts a dialog for user to create a pipeline parameter with the specified parameter value.
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_Data_Value|Set_Pipeline_Parameter_To_Data_Value]]
-=== prompt_for_multiple_pipeline_parameter_values ===
+Create a pipeline parameter with the values of a signal
-prompts a dialog for user to create multiple pipeline parameters with the specified parameter values.
+== Set_Pipeline_Parameter_From_Expression ==
-=== get_pipeline_parameter_count ===
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_From_Expression|Set_Pipeline_Parameter_From_Expression]]
-get a count of the number of parameter values in a parameter
+Create a pipeline parameter from an expression
-=== get_pipeline_parameter_index_value ===
+== Set_Pipeline_Parameter_From_For_Loop ==
-create a pipeline parameter containing the value of one component (e.g. index) from another parameter.
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_From_For_Loop|Set_Pipeline_Parameter_From_For_Loop]]
-=== for_each and end_for_each ===
+Create a pipeline parameter to mimic a traditional for loop.
-executes pipeline commands multiple times for each item in a list of items. it is not identical with a "for loop" or "do loop" in a programming language because the items must be explicitly defined as items in the command. this has some powerful consequences because it means that you can "loop" through disconnected items or strings as easily as using a structured list.
+== Prompt_For_Pipeline_Parameter_Value ==
-=== conditional_statement and conditional_statement_end ===
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Prompt_For_Pipeline_Parameter_Value|Prompt_For_Pipeline_Parameter_Value]]
-executes pipeline commands that occur between conditional_statement and conditional_statement_end. the intermediate commands will only be executed if the expression in the conditional_statement command is true (returns any value other than 0).
+Prompts a dialog for user to create a pipeline parameter with the specified parameter value.
-=== halt_pipeline_on_error ===
+== Prompt_For_Multiple_Pipeline_Parameter_Values ==
-another debugging feature of the pipeline workshop is the ability to halt execution of commands on the "first error". when the first error occurs, commands will stop executing and the errors and warnings will appear in the processing results window.
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Prompt_For_Multiple_Pipeline_Parameter_Values|Prompt_For_Multiple_Pipeline_Parameter_Values]]
-=== pipeline_breakpoint ===
+Prompts a dialog for user to create multiple pipeline parameters with the specified parameter values.
-this command will place a breakpoint in the pipeline that will allow the user to review the results from the previous pipeline commands and resume when you feel you are ready to resume or halt if you are not.
+== Get_Pipeline_Parameter_Count ==
-=== comment ===
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Get_Pipeline_Parameter_Count|Get_Pipeline_Parameter_Count]]
-<html><ul></html>
+Get a count of the number of parameter values in a parameter
-<html><li></html><html><ul></html>
-<html><li></html>%%__%%add_a_comment%%__%%%%**%%<html></li></html><html></ul></html>
-<html></li></html><html></ul></html>
-! /comment=
+== Get_Pipeline_Parameter_Index_Value ==
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Get_Pipeline_Parameter_Index_Value|Get_Pipeline_Parameter_Index_Value]]
+Create a pipeline parameter containing the value of one component (e.g. index) from another parameter.
+== For_Each and End_For_Each ==
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|for_each_and_end_for_each]]
+Executes pipeline commands multiple times for each item in a list of items. It is not identical with a "for loop" or "do loop" in a programming language because the items must be explicitly defined as ITEMS in the command. This has some powerful consequences because it means that you can "loop" through disconnected items or strings as easily as using a structured list.
+== Conditional_Statement and Conditional_Statement_End ==
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Conditional_Statement|Conditional_Statement]]
+Executes pipeline commands that occur between Conditional_Statement and Conditional_Statement_End. The intermediate commands will only be executed if the EXPRESSION in the Conditional_Statement command is TRUE (returns any value other than 0).
+== Halt_Pipeline_On_Error ==
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Halt_Pipeline_On_Error|Halt_Pipeline_On_Error]]
+Another debugging feature of the Pipeline Workshop is the ability to halt execution of commands on the "first error". When the first error occurs, commands will stop executing and the errors and warnings will appear in the processing results window.
+== Pipeline_Breakpoint ==
+[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Pipeline_Breakpoint|Pipeline_Breakpoint]]
+This command will place a breakpoint in the pipeline that will allow the user to review the results from the previous pipeline commands and resume when you feel you are ready to resume or halt if you are not.
+== Comment ==
+<HTML><ul></HTML>
+<HTML><li></HTML><HTML><ul></HTML>
+<HTML><li></HTML>%%__%%Add_a_Comment%%__%%%%**%%<HTML></li></HTML><HTML></ul></HTML>
+<HTML></li></HTML><HTML></ul></HTML>
+! /COMMENT=
 **;**