com.azalient.api
Class CommuterAPI

java.lang.Object
  com.azalient.api.CommuterAPI

public class CommuterAPI
extends Object

Start Here - this is the entry point to creating a stand-alone application. If you are creating a plugin which you want to load from within a Commuter model, see BasePlugin

Method Summary

static ICommuter	commuter() Return the singleton instance of Commuter, or create one, with no command-line arguments
static ICommuter	startCommuter(String[] args) Start a singleton instance of the Commuter application, and return a handle to that instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

startCommuter

public static ICommuter startCommuter(String[] args)

Start a singleton instance of the Commuter application, and return a handle to that instance. If an instance has already been created within this JVM, return that instance, ignoring the arguments.

Parameters:

args - command line arguments, which can include:

• -batch Run in batch mode, with no graphical window, and internal saving disabled (results may be saved to external files, but the AZA file is read-only). By default -batch implies -go. See also -nogo and -store.
• -scenario=name Set scenario, where name is a valid scenario name.
• -store Store batch run results in AZA file (valid only with -batch). Allows saving of file in batch mode
• -go Start simulation immediately (can be used in batch or window mode). This is the default setting in batch mode.
• -nogo Do not start simulation immediately (for use in batch mode, with API).
• -config Show the dialog to change the system configuration, then exit.
• -stdout Run Commuter as a console (stdout) application. (uses java.exe, not javaw.exe)
• -help Display a help message showing the options
• [full path to AZA model file] open the given model file

Returns:

handle to Commuter object

commuter

public static ICommuter commuter()

Return the singleton instance of Commuter, or create one, with no command-line arguments

Returns:

handle to Commuter object