Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:pipeline_breakpoint [2024/06/26 20:28] – created sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:pipeline_breakpoint [2026/02/04 16:44] (current) – [Command Parameters] wikisysop
@@ Line 1: / Line 1: @@
-====== Pipeline_Breakpoint ======
+====== Pipeline Breakpoint ======
-This command will place a breakpoint in the pipeline that will allow the user assess their current progress before continuing. A dialog will pop-up and a custom message will be shown to the user along with two buttons: one allowing you to resume and the other if you wish to halt. The command is as follows:
+This command will place a breakpoint in the pipeline that will allow the user assess their current progress before continuing. A dialog will pop-up and a custom message will be shown to the user along with two buttons: one allowing you to resume and the other if you wish to halt.
-**Pipeline_Breakpoint**
+====Pipeline Syntax====
+The command appears in the Pipeline Workshop within the Pipeline Control folder as so:
+<code>
+Pipeline_Breakpoint
 /PAUSE_MESSAGE=
-**;**
+;
-The message can be formatted using a simple version of the rtf file format.
+</code>
-For example, the following command will output four separate lines in the breakpoint prompt dialg
+====Command Parameters====
+The command can be modified by changing the following parameter:
+|**Pause Message**|The message that is shown to the user at the breakpoint|
-**Pipeline_Breakpoint**
+=====Example: Formatting Message in RTF =====
+The message can be formatted using a simple version of the rtf file format. For example, the following command will output four separate lines in the breakpoint prompt dialog
+<code>
+Pipeline_Breakpoint
 /PAUSE_MESSAGE= {\rtf1\ansi\deff0
 \pard One\par
@@ Line 17: / Line 27: @@
 \pard Four\par
 }
-**;**
+;
-===== Syntax Issue =====
+</code>
-Consider the following:
+===== Syntax Considerations =====
+Consider the following command:
+<code>
+Pipeline_Breakpoint
 /PAUSE_MESSAGE=08/09/2017 by WSS Speed = 0.4
-A forward slash (/) is a special character for pipeline commands that indicates that a parameter_name follows immediately afterwards.
+;
-If an equals sign (=) follows Visual3D confirms that a parameter was specified.
+</code>
-Two equals signs (==), however, does confirm that a parameter was specified.
-Visual3D searches for an equals sign after each slash because this logically indicates that the user has specified a parameter.
+This pause message includes several special characters, notably the forward slash (/) which is a special character for pipeline commands indicating that a parameter name follows immediately afterwards. If an equals sign, "=", follows Visual3D confirms that a parameter was specified. Two equals signs, "==", however, does confirm that a parameter was specified.
-Pause_Message is assigned the string 08/09
-Visual3D finds an equals sign after the next slash, so interprets the rest of the string as a new parameter
+In this example, Visual3D searches for an equals sign after each slash because this logically indicates that the user has specified a parameter. The /Pause_Message parameter is assigned the string 08/09 and then Visual3D finds an equals sign after the next slash, so interprets the rest of the string as a new parameter "/2017 by WSS Speed = 0.4". Visual3D won't do anything with this parameter because it doesn't recognize it.
-/2017 by MJT using Modify_Speed_Metric_Ver01 Speed = 0.4
-It doesn't do anything with this parameter because it doesn't recognize it.
+The solution to this syntax issue is to either remove the "=" sign:
-Solution
+<code>
-remove the = sign
 /PAUSE_MESSAGE=08/09/2017 by WSS Speed 0.4
-or specify two equals signs
+</code>
+or to specify two equals signs "==":
+<code>
 /PAUSE_MESSAGE=08/09/2017 by WSS Speed == 0.4
-===== Example Pipeline =====
+</code>
+===== Example =====
 <code>