Skip to content

RUN_PATH_ANALYSIS

This command executes the path-analysis without showing the start dialog.

Syntax

leo-grammar
CC "Simulation" RUN_PATH_ANALYSIS modelid:intValue
								[ runs:intValue ]
								[ dpy:intValue ]
								[ hpd:intValue ]
								[ simoption:intValue ]
								[ auto-read-only:boolValue ]
								[ auto-close:boolValue ]
								[ auto-loop:boolValue ]
								[ setLoopDetectionCount:intValue ]
								[ randseed:intValue ]
								[ programcalls:boolValue ]
								[ no-error-messages:boolValue ]
								[ no-result-window ]
								[ auto-save-results: only-proc | activities-avg | activities-total ]
								[ pathfile:strValue ]
								[ filetype:strValue ]
								[ header:boolValue ]
								[ time-as-number:boolValue ]

#--> RESULT ecode:intValue 
			errmsg:strValue
CC "Simulation" RUN_PATH_ANALYSIS modelid:intValue
								[ runs:intValue ]
								[ dpy:intValue ]
								[ hpd:intValue ]
								[ simoption:intValue ]
								[ auto-read-only:boolValue ]
								[ auto-close:boolValue ]
								[ auto-loop:boolValue ]
								[ setLoopDetectionCount:intValue ]
								[ randseed:intValue ]
								[ programcalls:boolValue ]
								[ no-error-messages:boolValue ]
								[ no-result-window ]
								[ auto-save-results: only-proc | activities-avg | activities-total ]
								[ pathfile:strValue ]
								[ filetype:strValue ]
								[ header:boolValue ]
								[ time-as-number:boolValue ]

#--> RESULT ecode:intValue 
			errmsg:strValue

Parameters

  • modelid (idValue) - the default model ID
  • runs (intValue, optional) - number of simulation runs
  • dpy (realValue, optional) - default days per year
  • hpd (realValue, optional) - default hours per day
  • simoption (intValue, optional) - number of the SimMapping option to be used [1 .. n]. If not given, the default (e.g. from the last simulation) will be used. If a too small value (<= 0) is passed, 1 is assumed.
  • auto-read-only (boolValue, optional) - sets an automated answer to the query about models being loaded in read-only mode. The query will not be displayed to the user.
  • auto-close (boolValue, optional) - sets an automated answer to the query about models being closed after the simulation. The query will not be displayed to the user.
  • auto-loop (boolValue, optional) - sets an automated answer to the query about continuing simulation although a probably endless loop was detected. The query will not be displayed to the user. (Note: If the simulation is unable to continue because of an endless loop exhausting the available system resources, a Windows system error message will still be displayed. Afterwards ADOxx may crash because of missing system resources.)
  • setLoopDetectionCount (intValue, optional) - sets the number of subsequent objects within one process instance which indicate that an endless loop has to be assumed. If no count is given, the standard value 5000 ist used. Note that loop detection is only performed during path analysis and volume analysis, not during workload analysis.
  • randseed (intValue, optional) - default randseed-value for the deterministic simulation.
  • programcalls (boolValue, optional) - sets a default value for the passive simulation component "programcalls". If this parameter is not given, the last value (from previous simulatio runs) will be used. If no simulation was performed previously, then the default value is 0 ("off").
  • no-error-messages (boolValue, optional) - if set to 1 then no simulation error messages will be displayed. If an error occurs, the simulation is simply aborted and the error message is returned in the return value errmsg.
  • no-result-window (modifier, optional) - if given, no result window will be displayed.
  • auto-save-results|only-proc | activities-avg | activities-total, if given, the simulation results will automatically be saved to the models after the simulation. There are three different save modes (just like in the dialog after the simulation): only-proc: only the process results will be saved to the process start object of the main process. No activity results will be saved; activities-avg: average activity results will be saved; activities-total: total activity results will be saved.
  • pathfile (strValue, optional) - path to the file where the results (simulation paths) are to be stored. Only if this option is given, the options filetype, header, and time-as-number are evaluated.
  • filetype (strValue, optional) - the type of the file with the simulation pathes to be generated. Currently only "csv" and "txt" are supported. If this option is not given, file type "txt" is generated.
  • header (boolValue, optional) - flag if a header information is to be generated in the simulation result file (1 | 0). If this option is not given, no header is generated.
  • time-as-number (boolValue, optional) - flag if times in the simulation result are generated as number (in seconds) or not (1 | 0). If this option is not given, the times are generated in the ADOxx time format and not as number of seconds.

Returns

  • ecode (intValue) - 0 for success or 1 if the dialog was canceled or an error occured
  • errmsg (strValue) - holds the error message of the last (if any) simulation-error that occured. This message is the same text that is usually displayed to the user in an ErrorBox.

Details

After the Path Analysis the result value is returned immediately after the opening of the simulation result window. Your AdoScript will therefore continue immediately - even before the simulation result window has been closed.

Since ADOxx 1.2 it is possible to continue with AdoScript-commands also only after closing the simulation result window: The AdoScript has to be separated into two parts. The first part ends with the start of the path analysis. The second part contains the code that shall be executed once the result window has been closed. It is placed in the handler of the AdoScript event "<SimulationEnded>" .

See Also

SimulationEnded
EXEC_PATH_ANALYSIS_DLG

Examples

Versions and Changes

Available since ADOxx 1.3