Environment#

public class Environment extends EnvironmentBase#: This class provides access to the environment variables and provides facilities to specify where to load the underlying AMPL interpreter.

Fields#

PATH#

public static final String PATH#

Get the platform dependent name of the path environment variable. To append a directory to current list of system paths, follow the snippet below:

Environment e = new Environment();
String paths = e.get(Environment.PATH);
e.put(Environment.PATH, paths + java.io.File.pathSeparatorChar + "/mynewpath");

Note that changing the paths in this way has effect only until the underlying AMPL process is started (in the AMPL constructor).

Constructors#

Environment#

public Environment()#: Default constructor, just copies the values of the current system environment variables. Expects the AMPL binary in a directory included in the system paths list or in the default position (which is APIJARLOCATION/ampl)

Environment#

public Environment(String binDir)#

Permits the user to specify a custom location for the AMPL executable.

Parameters:

binDir – Directory to search the AMPL executable in

Environment#

public Environment(String binDir, String binName)#

Permits the user to specify a custom location and name for the AMPL executable.

Parameters:

binDir – Directory to search the AMPL executable in
binName – Name of the AMPL executable if other than “ampl”

Methods#

containsKey#

public boolean containsKey(Object key)#

get#

public String get(Object key)#

getBinDir#

public String getBinDir()#: Returns the directory containing the overriding AMPL executable directory.

getBinName#

public String getBinName()#: Returns the name of the AMPL executable.

getWorkingDir#

String getWorkingDir()#: Returns the path to the current working directory.

isEmpty#

public boolean isEmpty()#

put#

public void put(String key, String value)#

setBinDir#

public void setBinDir(String exePath)#

Sets the directory in which the AMPL executable is located. Does not perform any check regarding whether the AMPL executable in there is working or not.

Parameters:

exePath – Path to the AMPL executable (without file name)

setBinName#

public void setBinName(String exeName)#

Sets the name of the AMPL executable. Does not perform any check regarding whether the AMPL executable in there is working or not.

Parameters:

exeName – Name of the AMPL executable

size#

public int size()#

toString#

public String toString()#