Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter [2024/07/12 14:06] – created sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter [2026/02/04 20:48] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Set_Pipeline_Parameter ======
+====== Set Pipeline Parameter ======
+This command can be used to set the value of a pipeline parameter to a specified value as defined by the user. Also see [[visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_to_data_value|Set Pipeline Parameter to Data Value]] and [[visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_from_expression|Set Pipeline Parameter from Expression]] for other options to define pipeline parameter values.
-Pipeline parameters can be created in the pipeline and used as variables in other commands in the same pipeline.
+====Pipeline command====
+This command can be found in the Pipeline Workshop within the Pipeline Control folder as shown below:
+<code>
+Set_Pipeline_Parameter
+/PARAMETER_NAME=
+/PARAMETER_VALUE=
+! /PARAMETER_VALUE_SEARCH_FOR=
+! /PARAMETER_VALUE_REPLACE_WITH=
+! /PARAMETER_VALUE_PREFIX=
+! /PARAMETER_VALUE_APPEND=
+! /MULTI_PASS=FALSE
+;
+</code>
-|**Set_Pipeline_Parameter**        |                                                                                                                                                                                                                                                                                                                                                           | | |
+====Command Parameters====
-|**/Parameter_Name=**              |The name of the Pipeline Parameter. The parameter is referred to by other commands using two colons (::) in front of the parameter name                                                                                                                                                                                                                    | | |
+The following table shows the command parameters that can be used to define the command and their descriptions:
-|**/Parameter_Value=**             |The value of the parameter. If a "+" delimeter is used in the value, the text string is maintained so that the Pipeline parameter is interpreted as multiple values when used in a command. If a "+" delimeter is used in the value, the entries in the line are concatenated, and will be treated as a single value when they are used in another command.| | |
-|**/Parameter_Value_Search_For=**  |                                                                                                                                                                                                                                                                                                                                                           | | |
+|**Parameter**   |**Description**|
-|**/Parameter_Value_Replace_With=**|A string of characters that will replace the "search for" string. This can be useful if you want to replace some of the terms within an existing Global Parameter value                                                                                                                                                                                    | | |
+|**Parameter Name**|The name of the Pipeline Parameter. The parameter is referred to by other commands using two colons (::) in front of the parameter name|
-|**/Multi_Pass=**                  |FALSE                                                                                                                                                                                                                                                                                                                                                      |-|;|
+|**Parameter Value**|The value of the parameter. If a "+" delimeter is used in the value, the text string is maintained so that the Pipeline parameter is interpreted as multiple values when used in a command. If a "+" delimeter is used in the value, the entries in the line are concatenated, and will be treated as a single value when they are used in another command.|
+|**Parameter Value Search For**|Search for parameters with this value|
+|**Parameter Value Replace With**|Replace the searched for value with this value|
+|**Multi Pass**|True or False: |
 ==== Example: Set Pipeline Values via Search and Replace ====