Difference between revisions of "CAEngine::DefaultEvaluationTimeLimit"
(Marked this version for translation) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | [[Category:ADE User Guide]] | ||
| + | [[ADE User Guide]] > [[ADE Server Class Reference]] > [[CAEngine]] | ||
<languages /> | <languages /> | ||
<translate> | <translate> | ||
| + | |||
<!--T:1--> | <!--T:1--> | ||
| − | |||
| − | |||
| − | |||
''New to [[What's new in Analytica 4.3?|ADE 4.3]]'' | ''New to [[What's new in Analytica 4.3?|ADE 4.3]]'' | ||
| − | = Description = | + | = Description = <!--T:2--> |
| + | <!--T:3--> | ||
The maximum time limit in milliseconds imposed on evaluations from methods in CAEngine, i.e., SendCommand, Send, OpenModel, and AddModule, as well as the default value for [[CAObject::MethodEvaluationTimeLimit]] for any CAObjects instantiated. A value of zero indicates no time limit. | The maximum time limit in milliseconds imposed on evaluations from methods in CAEngine, i.e., SendCommand, Send, OpenModel, and AddModule, as well as the default value for [[CAObject::MethodEvaluationTimeLimit]] for any CAObjects instantiated. A value of zero indicates no time limit. | ||
| − | = Data Type = | + | = Data Type = <!--T:4--> |
| + | <!--T:5--> | ||
long | long | ||
| − | = Access = | + | = Access = <!--T:6--> |
| + | <!--T:7--> | ||
read/write | read/write | ||
| − | = Example Usage = | + | = Example Usage = <!--T:8--> |
| − | CAEngine ade = new CAEngine; | + | <!--T:9--> |
| + | CAEngine ade = new CAEngine; | ||
ade.DefaultEvaluationTimeLimit = 10000 /*ms*/; // abort any computation that takes more than 10 seconds | ade.DefaultEvaluationTimeLimit = 10000 /*ms*/; // abort any computation that takes more than 10 seconds | ||
| − | = When to use = | + | = When to use = <!--T:10--> |
| + | <!--T:11--> | ||
Use this if you are worried about a computation (perhaps in an arbitrary model) taking an excessively long time and thus hogging CPU cycles. | Use this if you are worried about a computation (perhaps in an arbitrary model) taking an excessively long time and thus hogging CPU cycles. | ||
| + | <!--T:12--> | ||
For computation of variable results, you have the option of setting [[CAObject::MethodEvaluationTimeLimit]] instead. However, if you want to limit the time spent when a typescript command is evaluated (e.g., via [[CAEngine::SendCommand]]), or for evaluations that occur when opening a model, then you must set the time limit using this property. | For computation of variable results, you have the option of setting [[CAObject::MethodEvaluationTimeLimit]] instead. However, if you want to limit the time spent when a typescript command is evaluated (e.g., via [[CAEngine::SendCommand]]), or for evaluations that occur when opening a model, then you must set the time limit using this property. | ||
| + | <!--T:13--> | ||
An alternative to limiting the maximum evaluation time is to provide your users with an "abort" functionality, such as Ctrl+Break. See [[How to Abort an ADE Computation]]. | An alternative to limiting the maximum evaluation time is to provide your users with an "abort" functionality, such as Ctrl+Break. See [[How to Abort an ADE Computation]]. | ||
| − | = See Also = | + | = See Also = <!--T:14--> |
| + | <!--T:15--> | ||
* [[CAObject::MethodEvaluationTimeLimit]] | * [[CAObject::MethodEvaluationTimeLimit]] | ||
* [[How to Abort an ADE Computation]] | * [[How to Abort an ADE Computation]] | ||
</translate> | </translate> | ||
Latest revision as of 22:22, 11 June 2015
ADE User Guide > ADE Server Class Reference > CAEngine
New to ADE 4.3
Description
The maximum time limit in milliseconds imposed on evaluations from methods in CAEngine, i.e., SendCommand, Send, OpenModel, and AddModule, as well as the default value for CAObject::MethodEvaluationTimeLimit for any CAObjects instantiated. A value of zero indicates no time limit.
Data Type
long
Access
read/write
Example Usage
CAEngine ade = new CAEngine; ade.DefaultEvaluationTimeLimit = 10000 /*ms*/; // abort any computation that takes more than 10 seconds
When to use
Use this if you are worried about a computation (perhaps in an arbitrary model) taking an excessively long time and thus hogging CPU cycles.
For computation of variable results, you have the option of setting CAObject::MethodEvaluationTimeLimit instead. However, if you want to limit the time spent when a typescript command is evaluated (e.g., via CAEngine::SendCommand), or for evaluations that occur when opening a model, then you must set the time limit using this property.
An alternative to limiting the maximum evaluation time is to provide your users with an "abort" functionality, such as Ctrl+Break. See How to Abort an ADE Computation.
Enable comment auto-refresher