HAS-Motion Software Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Pipeline Control Commands ======

An important feature of the pipeline is the ability to create and use Pipeline Parameters.

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.

== Set_Pipeline_Parameter ==

[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter|Set_Pipeline_Parameter]]

Pipeline parameters can be created in the pipeline and used as variables in other commands in the same pipeline.

== Set_Pipeline_Parameter_To_Folder_Path ==

[[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 a pipeline parameter to be the Folder path.

== Set_Pipeline_Parameter_To_List_Of_Tagged_Files ==

[[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]]

Creates a pipeline parameter containing the names of the TAGGED files.

== Set_Pipeline_Parameter_To_List_Of_Files ==

[[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]]

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_Signal_Names ==

[[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]]

In order to process multiple signals it can be useful to identify all of the signals of a given type.

== Set_Pipeline_Parameter_To_Data_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]]

Create a pipeline parameter with the values of a signal

== Set_Pipeline_Parameter_From_Expression ==

[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_From_Expression|Set_Pipeline_Parameter_From_Expression]]

Create a pipeline parameter from an expression

== Set_Pipeline_Parameter_From_For_Loop ==

[[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]]

Create a pipeline parameter to mimic a traditional for loop.

== Prompt_For_Pipeline_Parameter_Value ==

[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Prompt_For_Pipeline_Parameter_Value|Prompt_For_Pipeline_Parameter_Value]]

Prompts a dialog for user to create a pipeline parameter with the specified parameter value.

== Prompt_For_Multiple_Pipeline_Parameter_Values ==

[[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]]

Prompts a dialog for user to create multiple pipeline parameters with the specified parameter values.

== Get_Pipeline_Parameter_Count ==

[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Get_Pipeline_Parameter_Count|Get_Pipeline_Parameter_Count]]

Get a count of the number of parameter values in a parameter

== 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=
**;**