Skip to content

EXEC_STEADY_WORKLOAD_ANALYSIS_DLG

This command executes the steady workload analysis start dialog.

Syntax

leo-grammar
CC "Simulation" EXEC_STEADY_WORKLOAD_ANALYSIS_DLG
												[ runs:intValue ]
												[ day:intValue ]
												[ month:intValue ]
												[ simoption:intValue ]
												[ auto-read-only:boolValue ]
												[ auto-close:boolValue ]
												[ auto-component:boolValue ]
												[ randseed:intValue ]
												[ programcalls:boolValue ]
												[ activity-analysis:boolValue ]
												[ calculation:boolValue ]
												[ animation:boolValue ]
												[ ProtocolSettings ]
												[ appmodelname:strValue ]
												[ no-error-messages:boolValue ]

ProtocolSettings: protocol:none | short-format | long-format 
				[ protfile:strValue ]

#--> RESULT ecode:intValue 
			errmsg:strValue 
			canceled:boolValue
CC "Simulation" EXEC_STEADY_WORKLOAD_ANALYSIS_DLG
												[ runs:intValue ]
												[ day:intValue ]
												[ month:intValue ]
												[ simoption:intValue ]
												[ auto-read-only:boolValue ]
												[ auto-close:boolValue ]
												[ auto-component:boolValue ]
												[ randseed:intValue ]
												[ programcalls:boolValue ]
												[ activity-analysis:boolValue ]
												[ calculation:boolValue ]
												[ animation:boolValue ]
												[ ProtocolSettings ]
												[ appmodelname:strValue ]
												[ no-error-messages:boolValue ]

ProtocolSettings: protocol:none | short-format | long-format 
				[ protfile:strValue ]

#--> RESULT ecode:intValue 
			errmsg:strValue 
			canceled:boolValue

Parameters

  • runs (intValue, optional) - Default number of simulation runs.
  • day (intValue, optional) - Default start day for simulation.
  • month (intValue, optional) - Default start month for simulation.
  • 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. If "auto-save-results" is activated, there will still appear an error message, if some models are in read-only mode when saving the results is attemted.
  • 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-component (boolValue, optional) - Sets an automated answer to the query about passive simulation components being disabled. The query will not be displayed to the user.
  • 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).
  • activity-analysis (boolValue, optional) - Sets a default value for the passive simulation component "activity analysis". 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 1 (on).
  • calculation (boolValue, optional) - Sets a default value for the passive simulation component "calculation". 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 1 (on).
  • animation (boolValue, optional) - Sets a default value for the passive simulation component "animation". 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 1 (on).
  • protocol(enumValue) - Sets a default value for the passive simulation component "simulation protocol". Allowed values are none (no protocol is generated), short-format (short format protocol) and long-format (long format protocol). Default = none.
  • protfile (strValue, optional) - Path to the protocol file.
  • appmodelname (strValue, optional) - Default application model name.
  • 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.

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.
  • canceled (boolValue) - reports whether the start dialog of the simulation has been canceled. It does not report whether the user did cancel at any other point of the simulation.

Details

See Also:

Examples

Versions and Changes

Available since ADOxx 1.3