Differences

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

--- visual3d:documentation:pipeline:other_commands:create_text_data [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:other_commands:create_text_data [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{{{====== command ======
+====== Create Text Data ======
-create a signal that contains text instead of a number.
+===== Command =====
-createtextdatadlg1.jpg
+Create a signal that contains text instead of a number.
-create_text_data
+{{:CreateTextDataDlg1.jpg}}
-/signal_folder=test
-/signal_name=hello
+Create_Text_Data
-/text_data=hello world!
+/SIGNAL_FOLDER=TEST
-/text_file_name=
+/SIGNAL_NAME=HELLO
-! /prompt_on_empty=true
+/TEXT_DATA=Hello World!
+/TEXT_FILE_NAME=
+! /PROMPT_ON_EMPTY=TRUE
 **;**
-it is possible to specify **either** text_data or text_file_name but not both.
+It is possible to specify **EITHER** TEXT_DATA or TEXT_FILE_NAME but not both.
-/text_file_name refers to a the full pathname of a file on disk that will be read as a text string (e.g. an rtf file).
+/TEXT_FILE_NAME refers to a the full pathname of a file on disk that will be read as a text string (e.g. an RTF file).
 \\
-if /prompt_on_empty==true
+if /PROMPT_ON_EMPTY==TRUE
 and the text box and filename edit box are empty
 the user is prompted for input.
-createtextdatadlg2.jpg
+{{:CreateTextDataDlg2.jpg}}
-example: given the dialog
+Example: Given the dialog
-createtextdatadlg3.jpg
+{{:CreateTextDataDlg3.jpg}}
-the resulting signal in the workspace is:
+The resulting signal in the workspace is:
-textitemsignal.jpg
+{{:TextItemSignal.jpg}}
-====== syntax issue ======
+===== Syntax Issue =====
-consider the following:
+Consider the following:
-/text_data=08/09/2017 by wss speed = 0.4
+/TEXT_DATA=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.
+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.
+If an equals sign (=) follows Visual3D confirms that a parameter was specified.
-two equals signs (==), however, does confirm that a parameter was specified.
+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.
+Visual3D searches for an equals sign after each slash because this logically indicates that the user has specified a parameter.
-text_data is assigned the string 08/09
+Text_Data 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
+Visual3D finds an equals sign after the next slash, so interprets the rest of the string as a new parameter
-/2017 by mjt using modify_speed_metric_ver01 speed = 0.4
+/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.
+It doesn't do anything with this parameter because it doesn't recognize it.
-solution
+Solution
 remove the = sign
-/text_data=08/09/2017 by wss speed 0.4
+/TEXT_DATA=08/09/2017 by WSS Speed 0.4
 or specify two equals signs
-/text_data=08/09/2017 by wss speed == 0.4
+/TEXT_DATA=08/09/2017 by WSS Speed == 0.4
-}}}}}}}}