Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:prompt_for_pipeline_parameter_value [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:prompt_for_pipeline_parameter_value [2025/03/18 16:54] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{{{prompts a dialog for user to create a pipeline parameter with the specified parameter value.
+====== Prompt For Pipeline Parameter Value ======
-prompt_for_pipeline_parameter_value.png
+Prompts a dialog for user to create a pipeline parameter with the specified parameter value.
+{{:Prompt_For_Pipeline_Parameter_Value.png}}
 <code>
-prompt_for_pipeline_parameter_value
+Prompt_For_Pipeline_Parameter_Value
-/pipeline_parameter_name= the parameter name
+/PIPELINE_PARAMETER_NAME= The parameter name
-/prompt=the text instructions to the user
+/PROMPT=The text instructions to the user
-! /data_type= data type of the parameter
+! /DATA_TYPE= Data type of the parameter
-! /default_value= default value of the parameter
+! /DEFAULT_VALUE= Default value of the parameter
-! /use_possible_values=false
+! /USE_POSSIBLE_VALUES=FALSE
-! /possible_values=
+! /POSSIBLE_VALUES=
-! /use_units=false
+! /USE_UNITS=FALSE
-! /default_units=
+! /DEFAULT_UNITS=
-! /use_possible_units=false
+! /USE_POSSIBLE_UNITS=FALSE
-! /possible_units=
+! /POSSIBLE_UNITS=
-! /conversions=
+! /CONVERSIONS=
 ;
 </code>
-====== rtf format ======
+===== RTF Format =====
-the prompt can be expressed as an rtf format but because of the parsing of commands in visual3d the user must be careful not to include the following reserved characters
+The prompt can be expressed as an RTF format but because of the parsing of commands in Visual3D the user must be careful not to include the following reserved characters
 / = ;
-saving rtf from ms word for example is full of these characters.
+Saving RTF from MS Word for example is full of these characters.
-with simple rtf formatting, however, it is straightforward to avoid using these characters.
+With simple RTF formatting, however, it is straightforward to avoid using these characters.
-/promtp= {\rtf1\ansi\deff0
+/PROMTP= {\rtf1\ansi\deff0
-\pard\qc centered\par
+\pard\qc Centered\par
-\pard\ql left\par
+\pard\ql Left\par
-\pard\qr right\par
+\pard\qr Right\par
-\pard\qj justified\par
+\pard\qj Justified\par
 }
-using color
+Using color
 {\rtf1\ansi\deff0
 {\colortbl;\red0\green0\blue0;\red255\green0\blue0;}
-this line is the default color\line
+This line is the default color\line
 \cf2
-this line is red\line
+This line is red\line
 \cf1
-this line is the default color
+This line is the default color
 }
-other useful formatting commands include:
+Other useful formatting commands include:
 \fs? for font size (where ? is twice the font size such that \fs24 results in a 12 point font)
 \i to turn italics on and \i0 to turn italics off
@@ Line 48: / Line 50: @@
 \caps to turn all capitals on and \caps0 to turn all capitals off
 \outl to turn outline on and \outl0 to turn outline off
-====== example: user input the initials of the patient ======
+===== Example: User input the initials of the Patient =====
+{{ :SetPipelineParameterDlg.png}}
+This example will prompt the user for the initials of the subject. The resulting pipeline parameter **GP_INITIALS** will contain the user input from the dialog.
+Prompt_For_Pipeline_Parameter_Value\\
+/PIPELINE_PARAMETER_NAME= GP_INITIALS\\
+/PROMPT= Enter the Initials of the Patient\\
+/DATA_TYPE=STRING\\
+/DEFAULT_VALUE=\\
+;
-this example will prompt the user for the initials of the subject. the resulting pipeline parameter **gp_initials** will contain the user input from the dialog.
+When the command is executed, a dialog prompt will appear asking the user to input the initials of the patient (see image on right)
-|\\ \\ \\ <code>\\ prompt_for_pipeline_parameter_value\\ /pipeline_parameter_name= gp_initials\\ /prompt= enter the initials of the patient\\ /data_type=string\\ /default_value=\\ ;\\ </code>\\ \\ \\ when the command is exectued, a dialog prompt will appear asking the user to input the initials of the patient (see image on right)  |setpipelineparameterdlg.png  |
+===== Example: Obstacle Height =====
-====== example: obstacle height ======
+This example will prompt the user for the height of an obstacle in **inches**. The resulting pipeline parameter **OBSTACLE_HEIGHT** will contain the user input from the dialog in **meters**.
-this example will prompt the user for the height of an obstacle in **inches**. the resulting pipeline parameter **obstacle_height** will contain the user input from the dialog in **meters**.
-}}}}