diff --git a/kepler/Strategist.xml b/kepler/Strategist.xml index de9dd11..5793ef4 100644 --- a/kepler/Strategist.xml +++ b/kepler/Strategist.xml @@ -2,7 +2,7 @@ - + @@ -121,7 +121,7 @@ - + null Edward A. Lee @@ -165,42 +165,6 @@ - - -null -Edward A. Lee -null -<p>StringParameter specifies a persistent string. </p> <p>Change the name of the StringParameter to better identify the specified value (right-click the parameter and select "Customize Name" from the menu). Other actors may refer to the StringParameter using the $NAME syntax (e.g. $Parameter). </p> - - - - - - - - - - - - - - - - - - - - -S- - - - - - - - - - - null @@ -346,7 +310,7 @@ - + null Edward A. Lee @@ -484,7 +448,7 @@ - + @@ -570,7 +534,7 @@ - + @@ -763,7 +727,7 @@ - + @@ -797,7 +761,7 @@ - + @@ -1034,7 +998,7 @@ - + @@ -1065,7 +1029,7 @@ - + @@ -1137,6 +1101,224 @@ + + + + + + + + + + + + + + + + + + + + + + + + +null +Xiaojun Liu, Edward A. Lee, Steve Neuendorffer +null + <p>The External Execution actor executes a system command from a workflow. The actor accepts a command, a directory and environment in which to execute the command, and a command input string. Once the command has finished executing, the actor will output the execution results along with any errors. If no results are generated, the actor will output an empty string.</p> <p>The External Execution actor depends on system-specific executables and is operating-system specific.</p> <p>To mimic the effect of executing a command in a shell interpreter, set the command parameter to "cmd" (Windows) or "sh" (Windows with Cygwin or Linux), and then provide commands, as a string, via the input port. Note that each passed command must be terminated with a newline. For example, to open a workflow in vergil and run it, set command to "sh" and use a StringConstant actor to pass the input port the string: "vergil -run model.xml\n exit\n"</p> +An input port that accepts strings to pass to the standard input of the subprocess. Note that a newline is not appended to the string. If you require a newline, add one using the AddSubtract actor. This port is an input port of type String. +An output port that broadcasts data generated by the executed command, output as a string after the command has finished executing. If the command generates no data on standard out, then the empty string (a string of length zero) is generated. +If connected, a token must be available on this port before actor will execute. +An output port that broadcasts any errors generated by the command execution. Errors are output as a string after the command has finished executing. If the execution generates no errors, an empty string is output. +An output port that broadcasts the command's exit code. A non-zero value signifies an error. +An array of records that name an environment variable and a value: {{name = "NAME1", value = "value1"}...} Where NAME1 is the name of the environment variable, and value1 is the value. For example, {{name = "PTII", value = "c:/ptII"}} would set the value of the PTII to c:/ptII. If the parameter is set to {{name="", value = ""}}, then the environment from the parent process is used. If environmental variables are set with the parameter, the parent values may not be passed to the process. To view the current environment, use the "env" command. +The directory in which to execute the command. The default value of this parameter $CWD, which represents the user's current working or SNS/users directory. +If true, then throw an exception if the subprocess returns non-zero. +If a positive integer, then it is the maximum number of times to execute the actor. + If true, then prepend the platform dependent shell command to the parsed value of the command parameter. By setting this argument to true, it is possible to invoke commands in a platform neutral method. <p>Under Windows NT or XP, the arguments "cmd.exe" and "/C" are prepended. Under Windows 95, the arguments "command.com" and "/C" are prepended. Under all other platforms, the arguments "/bin/sh" and "-c" are prepended. </p> <p>The default value of this parameter is a boolean of value false, which allows the user to arbitrarily invoke /bin/sh scripts on all platforms. </p> <p><b>NOTE:</b> This must be true if file redirection is used in <i>command</i>.</p> <p><b>NOTE:</b> Under Cygwin, if true, the path environment of the subprocess is not identical to the path of the calling process. In this case the full path to the program must be specified.</p> +If true, then actor will wait until subprocess completes. +The command to be executed (e.g., echo "Hello, world."). The command can be specified via either the command port or parameter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +null +Xiaojun Liu, Edward A. Lee, Steve Neuendorffer +null +<p>The Expression actor evaluates a specified expression (e.g., an addition or multiplication operation), which may reference the values of user-specified input ports, the current time, or the actor's iteration count. The actor outputs the value of the evaluated expression. </p> <p>Expressions are specified in the Ptolemy expression language via the expression parameter. For more information about the expression language, see http://ptolemy.eecs.berkeley.edu/papers/05/ptIIdesign1-intro/ptIIdesign1-intro.pdf. </p> <p>By default, the expression parameter is empty, and attempting to execute the actor without first specifying an expression generates an error. Expressions can refer to the values of inputs by the port name; to the current time by the identifier "time"; and to the current iteration count by the identifier "iteration." </p> <p>Input ports are created by the user and correspond to variables used in the specified expression. Currently, the Expression actor does not support input multiports. The actor requires all of its inputs to be present. If inputs are not all present, then the actor will generate an error. </p> <p>Note: the Expression actor can be used instead of many of the arithmetic actors, such as AddSubtract, MultiplyDivide, and TrigFunction. However, those actors will be usually be more efficient, and sometimes more convenient to use.</p> +An output port that broadcasts the value of the evaluated expression. The actor automatically determines the type based on the type of the input. +An expression to evaluate. Expressions are specified in the Ptolemy expression language. For more information about the expression language, see http://ptolemy.eecs.berkeley.edu/papers/05/ptIIdesign1-intro/ptIIdesign1-intro.pdf. By default, the parameter is empty, and attempting to execute the actor without first specifying an expression generates an error. Expressions can refer to the values of inputs by the port name; to the current time by the identifier "time"; and to the current iteration count by the identifier "iteration." + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +null +Yuhong Xiong, Edward A. Lee +null +<p>The Display actor reads tokens of any type via its input multiport, and displays each token on a separate line in a text display window.</p> <p>Specify the size of the text display window with the rowsDisplayed and columnsDisplayed parameters. Simply resizing the window onscreen does not persistently change the size when the workflow is saved, closed, and then re-opened. </p> <p>If the input is a string token, then the actor strips the surrounding quotation marks before displaying the value.</p> <p>Select the suppressBlankLines parameter to specify that the actor not add blank lines to the display. By default, the actor will add blank lines.</p> <p>Note: this actor can consume large amounts of memory. It is not advisable to use it to display large output streams.</p> +A multiport that accepts tokens of any type. +Specify whether the actor should display blank lines (the default) or suppress them. +The vertical size of the display, in rows. The value is an integer that defaults to 10. +The horizontal size of the display, in columns. The value is an integer that defaults to 40. +The title of the text display window. If specified, the value will appear in the title bar of the text display window. + + + + + + + + + + + + + + + + + +null +null +null +null + + + + + + + + + + + + + + + + + + + + @@ -1147,8 +1329,6 @@ - - @@ -1157,6 +1337,16 @@ + + + + + + + + + + @@ -1173,15 +1363,23 @@ - + + + + + + + + + - + @@ -1397,7 +1595,7 @@ - + @@ -1454,7 +1652,7 @@ - + @@ -2266,7 +2464,7 @@ - + @@ -2384,7 +2582,7 @@ - + @@ -2801,7 +2999,7 @@ - + @@ -3080,7 +3278,7 @@ - + @@ -3937,9 +4135,9 @@ - + - + @@ -4013,9 +4211,9 @@ - + - + @@ -4166,7 +4364,7 @@ - + @@ -4834,7 +5032,7 @@ - + null @@ -5223,7 +5421,7 @@ - + @@ -5341,7 +5539,7 @@ - + @@ -5663,9 +5861,9 @@ - + - + @@ -5982,7 +6180,7 @@ - + @@ -6124,7 +6322,7 @@ - + @@ -6395,7 +6593,7 @@ - + @@ -6403,7 +6601,7 @@ - + @@ -7260,9 +7458,9 @@ - + - + @@ -7336,9 +7534,9 @@ - + - + @@ -7489,7 +7687,7 @@ - + @@ -7883,7 +8081,7 @@ - + @@ -8157,7 +8355,7 @@ - + null @@ -8546,7 +8744,7 @@ - + @@ -8664,7 +8862,7 @@ - + @@ -8986,9 +9184,9 @@ - + - + @@ -9125,42 +9323,6 @@ - - - - - - - - - - - - - - -null -Yuhong Xiong, Edward A. Lee -null -<p>The Display actor reads tokens of any type via its input multiport, and displays each token on a separate line in a text display window.</p> <p>Specify the size of the text display window with the rowsDisplayed and columnsDisplayed parameters. Simply resizing the window onscreen does not persistently change the size when the workflow is saved, closed, and then re-opened. </p> <p>If the input is a string token, then the actor strips the surrounding quotation marks before displaying the value.</p> <p>Select the suppressBlankLines parameter to specify that the actor not add blank lines to the display. By default, the actor will add blank lines.</p> <p>Note: this actor can consume large amounts of memory. It is not advisable to use it to display large output streams.</p> -A multiport that accepts tokens of any type. -Specify whether the actor should display blank lines (the default) or suppress them. -The vertical size of the display, in rows. The value is an integer that defaults to 10. -The horizontal size of the display, in columns. The value is an integer that defaults to 40. -The title of the text display window. If specified, the value will appear in the title bar of the text display window. - - - - - - - - - - - - - @@ -9369,7 +9531,6 @@ - @@ -9995,7 +10156,7 @@ - + @@ -10149,7 +10310,7 @@ - +