 |
inoevalReplySel
|
| Purpose: |
Return server elements to the client that started the evaluation.
|
| Synopsis: |
inoevalReplySel element1 [element2 text]
|
| Arguments: |
| element1 |
Server element which is to be passed as a result of the script to the calling window. |
| element2 text (optional) |
Using this parameter one has the option to send back a further server element with additional textual data to the client. |
|
| Result: |
In case of a success, for each inoevalReplySel call the results are written into a list. After completing the Tcl script the list with the collected data is sent back to the client.
|
| Note: |
This command can be applied meaningful only in the three following variants:
|
|
| |
This command is necessary in scripts which are used in the model browser command Edit/Find when searching for server elements with Tcl scripts. The optional parameters have no meaning. |
| |
The command is used in scripts which are started as evaluation commands in Innovator windows. It serves then to return server elements as a result of the evaluation to the calling client so they are selected in the window. The optional parameters have no meaning. |
| |
|
In order to be able to do the selection, the option Wait for answer under Options/Configure/Evaluation is to be set in the window and the waiting box must not be deleted prior. |
| |
When doing a ERM/SERM documentation, the command is used as follows: if element2 is a target system, text is written in a chapter for SQL of the corresponding target system. |
|
|
inoevalReplyData
|
| Purpose: |
Return a set of external object names to the client that started the evaluation.
|
| Synopsis: |
inoevalReplyData mode string ...
|
| Arguments: |
| mode |
"Update" to store the object files, or "PrtList" to store the print files. |
| string ... |
Names of external objects. |
|
| Result: |
If successful, the names of the external objects are sent as a string list to the requesting client at once.
|
| Note: |
A script for processing external objects using inoexo should execute this command if the Save object or the Save docu button is pressed.
|
|
inoevalRequest
|
| Purpose: |
Read context data of a client request.
|
| Synopsis: |
inoevalRequest context
|
| Arguments: |
| context |
Type of context information. Possible values are: |
| |
client |
The name of the Innovator client from which the evaluation was started. |
| |
repository |
The name of the repository. |
| |
project |
The server element of the model. This is required, i.e. for inosrvSelect. |
| |
projectname |
The name of the model. This is required, i.e. for inoTreeLogin. |
| |
user |
The server element of the logged in user. |
| |
username |
The name of the logged in user. |
| |
window |
The server element, on which the window is based, from which the evaluation was started. |
| |
selection |
The list of server elements marked in the window. |
| |
args |
The arguments which have been specified for executing the script. |
| |
wait |
Shows if the Wait for answer has been pressed. |
|
| Note: |
The possible context data are not case sensitive and can be uniquely abbreviated.
|
| Result: |
The context information is the return value of the command.
|
| Example: |
# Determine the repository name
|
|
set rep [inoevalRequest Repository]
|
|
inoExitSet
|
| Purpose: |
Set exit value for script return code.
|
|
This value is used as return code by program inotcl using the -f or -c option. An uncatched Tcl error always returns code 255.
|
|
When executing a script as an evaluation command in the Innovator GUI, termination without reporting an error sets the exit value to 0 and causes the replacing of the selection with the set of elements returned by inoevalReplySel. If inoevalReplySel is not used in the script, the selection will be removed. In the model browser this will result in the deleting of the result region's contents. To avoid this commonly unwanted effect, the script can be caused to return any different exit value, e.g. 1.
|
| Synopsis: |
inoExitSet [value]
|
| Arguments: |
| value (optional) |
When a script exits without reporting an error, its exit value is 0. A different exit value can be set. If the GUI selection is not intended to be removed, an exit value of 1 is recommended. |
|
|
inoExitGet
|
| Purpose: |
Get exit value for script return code.
|
|
This value is used as return code by program inotcl using the -f or -c option.
|
| Synopsis: |
inoExitGet
|
| Result: |
Exit Value.
|
