Commands are actions that you can ask Vensim to take. Commands are used in Venapps, Command files and through the Vensim DLL. They can be given in response to user choices, or as part of setting things up.
Each command is entered as a class, followed by the specific command and options in the form class>command|option1|option2.... Commands can be combined using an ampersand &. If you want to include an ampersand & in a command you need to enter two as in &&. The Venapp editor will do this for you automatically. The classes are:
| • | BRANCH>BranchName will cause a Venapp to branch logical control to another location in the same screen. BranchName is defined using the BRANCH control. |
| • | CANCEL is used to prevent the reading of inputs from the current screen (CANCEL is a class with no specific commands). |
| • | CUSTOM>GraphName will create a custom graph or report. GraphName is the name of the custom graph or report. |
| • | ERROR>placeholder places error output into a window - normally used in a TOOL control. |
| • | EXPORT>GraphLab allows you to copy tool output or a sketch that is on the screen to the clipboard. Tool output is labeled when it is put up on the screen, and exporting uses this name. |
| • | FILE>command allows you to manipulate files. The FILE commands are COPY, CREATE, DECRYPT, DELETE, ENCRYPT, EXISTS, MDL2VMF, RENAME, VCD2VCF, VGD2VGF and VMF2MDL. |
| • | GAME>command allows you to control game activity. The GAME commands are BACKUP, ENDGAME, GAMEINTERVAL, GAMEON, READGIN, RELOAD and WRITEGIN. |
| • | IFTHENELSE is used to initiate a logical branching sequence. It appears as a class with no specific command and must be followed by three more commands separated by &. |
| • | LOG>command is used to log user actions. The LOG commands are CREATE, MESSAGE and TIMESTAMP. |
| • | MENU>command is used for commands that could be executed from the main Vensim menu were it visible. The MENU commands are DAT2VDF, EXIT, GAME, LOAD_RUN, REDO_GRAPHS, RUN, RUN1, RUN_OPTIMIZE, RUN_SENSITIVITY, TAB2VDF, VDF2DAT, VDF2TAB, VDF2WK1, VDF2XLS, WK12VDF and XLS2VDF. |
| • | PRINT>GraphLab allows you to print tool output or a sketch that is on the screen. Tool output is labeled when it is put up on the screen, and printing uses this name. You can also use this command to print the current screen. |
| • | SETTING>command allows you to control setting in Vensim that would normally be accessible from the Options dialog. The SETTING commands are EURONUMBER, EXPORTSIZE, EXTERNALFUNCTION, HOVERCOM, PRINTOPTQUERY, SHOWINITIAL, SHOWLOOKUP, SHOWMACRO, SHOWWARNING and SIZEINCHES. |
| • | SIMULATE>command allows you to control a simulation much like you could from the Simulation Control dialog. The SIMULATE commands are 1TABCHG, ADDCIN, ADDDATA, BASED, CHGFILE, DATA, GETCNSTCHG, GETTABCHG, MINMEN, OPTPARM, PAYOFF, READCIN, READRUNCHG, RESUME, RUNNAME, SAVELIST, SENSSAVELIST, SENSITIVITY, SETVAL and WRITECIN. |
| • | SPECIAL>command allows you to change things like those you could modify from the Control Panel. The SPECIAL commands are ALIASSCREEN, ASKYESNO, BUTTONFOCUS, CLEARRUNS, EXIT1, EXTERNAL, LOADAPPINT, LOADDLL, LOADMODEL, LOADRUN, LOADTOOLSET, MESSAGE, NOINTERACTION, READCUSTOM, READINI, REFRESH, RESETINPUT, SECONDCLICK, SETTITLE, SETWBITEM, STOP, STOPSIM, SUBSCRIPTS, VARSELECT and WINHELP. |
| • | SKETCH> command allows you to manipulate a visible sketch. The SKETCH commands are CHOOSEVIEW, NEXTVIEW, PREVVIEW and ZOOM. |
| • | TEST>condition is used to test input constants and computed model variables to be sure they meet specified conditions. This is normally used with IFTHENELSE. |
| • | TIMER>command allows you to set up timers for use in Venapps without needing a TIME control. |
| • | TIMEAXIS>command allows you to control the time axis used in graphs and tables. The TIMEAXIS commands are RESET, SPECIALTIME, STARTTIME, STOPTIME and TIMEBASE. |
| • | WORKBENCH>ToolName allow you to put up workbench tool output. |
NOTE CANCEL and IFTHENELSE always appear in isolation (no > or command name is used).
The command classes and individual commands are discussed in more detail below. They are organized alphabetically first by class, and then by command.
