vsTASKER 7 User Manual
×
Menu
Index

Properties

 
Properties
1

Name

1. Name
Name of the Batch object. Must be unique.
The name will be used to create a class. ie. Batch named Analysis1 will create a class named Analysis1_BatDef
 
2

When Done

2. When Done
Specify what will happen next, when the number of runs will be reached or when Exit Condition will return DONE:
  • Connect: when the batch object is connected to another batch object
  • Done: nothing will happen. The batch will just stop
  • Exit: vsTASKER will exit.
 
3

Scenario

3. Scenario
Specify which scenario will start under the Batch object.
Only one scenario can run per Batch object.
 
4

Starting

4. Starting
Checked if this batch starts the Batch Mode.
 
5

Disabled

5. Disabled
If checked, the Batch object will be skipped. If it is the starting one, the Batch Mode is also disabled.
 
6

Variables

6. Variables
Put in this panel all variables that will be used by the Batch object itself but also by any other simulation objects. Typically, the Batch object contains various variables that change at each iteration, based on various user strategies or based on result of the past runs. Each new run might use the Batch variables to setup their initial values.
 
7

Initialization

7. Initialization
Part called before the first iteration of the Batch object (RESET)
Refer to the Developer Guide for more details on system phases/events.
8

Runtime

8. Runtime
Part called as soon as the called scenario terminates.
Do here all the variable modification requested for the next scenario run.
Must return AGAIN if a new batch iteration is requested.
Return
DONE if the batch object must be left. Next connected Batch object will be activated. If none, batch mode is terminated.
Return QUIT if the batch mode must be terminated.
To check the number of iterations, use variable cIter() inside the code.
 
9

Help

9. Help
Put here all text explanations or documentation content needed to maintain this Viewer.
The Help content is saved but is not inserted into the generated code.
It will be used for the automatic document generation (see Make Documents)
 
10

Number of Runs

10. Number of Runs
If value is provided, it will stop the Batch object processing after the given number of iterations.
 
11

Exit Condition

11. Exit Condition
Put here the code that will be evaluated every second during the simulation run.
If code returns AGAIN, the Batch object remains active. If it returns DONE, the batch object stops the scenario the same way as using R:stop() into the code.
Runtime code of the Batch is then called (9).