Public Member Functions
GAMSDatabase	OutDB ()
	Retrieve GAMSDatabase created by Run method.

String	getJobName ()
	Retrieve the name of GAMSJob.

String	getFileName ()
	Retrieve the file name associated to GAMSJob.

void	run ()
	Run GAMSJob.

void	run (GAMSOptions options)
	Run GAMSJob with GAMSOptions.

void	run (GAMSCheckpoint checkpoint)
	Run GAMSJob with GAMSCheckpoint.

void	run (PrintStream output)
	Run GAMSJob and use java.io.PrintStream to capture GAMS log.

void	run (boolean createOutDB)
	Run GAMSJob will create an output GAMSDatabase by default.

void	run (GAMSDatabase ... databases)
	Run GAMSJob with existing GAMSDatbase(s).

void	run (GAMSOptions options, GAMSCheckpoint checkpoint)
	Run GAMSJob with GAMSOptions and GAMSCheckpoint.

void	run (GAMSOptions options, PrintStream output)
	Run GAMSJob with GAMSOptions and use java.io.PrintStream to capture GAMS log.

void	run (GAMSOptions options, boolean createOutDB)
	Run GAMSJob with GAMSOptions and use flag to determine if OutDB should be created during the run (true by default).

void	run (GAMSOptions options, GAMSDatabase ... databases)
	Run GAMSJob with GAMSOptions and existing GAMSDatbase(s).

void	run (GAMSOptions options, GAMSCheckpoint checkpoint, PrintStream output)
	Run GAMSJob with GAMSOptions and GAMSCheckpoint, also use java.io.PrintStream to capture GAMS log.

void	run (GAMSOptions options, GAMSCheckpoint checkpoint, boolean createOutDB)
	Run GAMSJob with GAMSOptions, GAMSCheckpoint, and flag to determine if OutDB should be created (true by default).

void	run (GAMSOptions options, GAMSCheckpoint checkpoint, GAMSDatabase ... databases)
	Run GAMSJob with GAMSOptions, GAMSCheckpoint, and existing GAMSDatabase(s).

void	run (GAMSOptions options, PrintStream output, boolean createOutDB)
	Run GAMSJob with GAMSOptions, also use java.io.PrintStream to capture GAMS log and use createOutDB flag to determine if OutDB should be created during the run (true by default).

void	run (GAMSOptions options, PrintStream output, GAMSDatabase ... databases)
	Run GAMSJob with GAMSOptions, existing GAMSDatabase(s), and use java.io.PrintStream to capture GAMS log.

void	run (GAMSOptions options, boolean createOutDB, GAMSDatabase ... databases)
	Run GAMSJob with GAMSOptions, existing GAMSDatabase(s), and set Flag determined if OutDB should be created (true by default).

void	run (GAMSOptions options, GAMSCheckpoint checkpoint, PrintStream output, boolean createOutDB)
	Run GAMSJob with GAMSOptions and GAMSCheckpoint, also use java.io.PrintStream to capture GAMS log and set flag determined if OutDB should be created (true by default).

void	run (GAMSOptions options, GAMSCheckpoint checkpoint, boolean createOutDB, GAMSDatabase ... databases)
	Run GAMSJob with GAMSOptions, GAMSCheckpoint, and existing GAMSDatabase(s); also set flag determined if OutDB should be created (true by default).

void	run (GAMSOptions options, PrintStream output, boolean createOutDB, GAMSDatabase ... databases)
	Run GAMSJob with GAMSOptions and existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log and set flag determined if OutDB should be created (true by default).

void	run (GAMSOptions options, GAMSCheckpoint checkpoint, PrintStream output, GAMSDatabase ... databases)
	Run GAMSJob with GAMSOptions, GAMSCheckpoint, and existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log.

void	runEngine (GAMSEngineRunParameters parameters)
	Run Engine Job with GAMSEngineRunParameters.

void	run (GAMSRunParameters parameters)
	Run GAMSJob with GAMSRunParameters.

void	run (GAMSOptions options, GAMSCheckpoint checkpoint, PrintStream output, boolean createOutDB, GAMSDatabase ... databases)
	Run GAMSJob with GAMSOptions, GAMSCheckpoint, and existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log and set flag determined if OutDB should be created (true by default).

void	run (GAMSCheckpoint checkpoint, PrintStream output)
	Run GAMSJob with GAMSCheckpoint and use java.io.PrintStream to capture GAMS log.

void	run (GAMSCheckpoint checkpoint, boolean createOutDB)
	Run GAMSJob with GAMSCheckpoint and set flag to determine if OutDB should be created (true by default).

void	run (GAMSCheckpoint checkpoint, GAMSDatabase ... databases)
	Run GAMSJob with GAMSCheckpoint and existing GAMSDatabase(s).

void	run (GAMSCheckpoint checkpoint, PrintStream output, GAMSDatabase ... databases)
	Run GAMSJob with GAMSCheckpoint and existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log.

void	run (GAMSCheckpoint checkpoint, boolean createOutDB, GAMSDatabase ... databases)
	Run GAMSJob with GAMSCheckpoint and existing GAMSDatabase(s), also set flag to determine if OutDB should be created (true by default).

void	run (GAMSCheckpoint checkpoint, PrintStream output, boolean createOutDB, GAMSDatabase ... databases)
	Run GAMSJob with GAMSCheckpoint and existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log and set flag to determine if OutDB should be created (true by default).

void	run (PrintStream output, boolean createOutDB)
	Run GAMSJob and use java.io.PrintStream to capture GAMS log also set flag to determine if OutDB should be created (true by default).

void	run (PrintStream output, GAMSDatabase ... databases)
	Run GAMSJob with existing GAMSDatabase(s) and use java.io.PrintStream to capture GAMS log.

void	run (PrintStream output, boolean createOutDB, GAMSDatabase ... databases)
	Run GAMSJob with existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log and set flag to determine if OutDB should be created (true by default).

void	run (boolean createOutDB, GAMSDatabase ... databases)
	Run GAMSJob with existing GAMSDatabase(s), also set flag to determine if OutDB should be created (true by default).

boolean	interrupt ()
	Send interrupt message to GAMS during GAMSJob instance executes its run method.

Detailed Description

An instance of GAMSJob manages the execution of a GAMS program given by GAMS model source. The GAMS source (or more precisely the root of a model source tree) of the job can be provided as a string or by a filename (relative to the working directory of the GAMSWorkspace) of a text file containing the GAMS model source. The run method organizes the export of the input GAMSDatabases, calls the GAMS compiler and execution system with the supplied options and on successful completion provides through the property OutDB (of type GAMSDatabase) the results of the model run.

While the result data is captured in a GAMSDatabase, the run method can also create a GAMSCheckpoint that not only captures data but represents the state of the entire GAMSJob and allows some other GAMSJob to continue from this state. In case of a compilation or execution error, the run method will throw an exception. If the log output of GAMS is of interest, this can be captured by providing a Java PrintStream instance.

A GAMSJob is connected to external resources and needs to be properly disposed before the Java garbage collector can claim the instance.

See also: GAMSCheckpoint; GAMSWorkspace; GAMSWorkspace.addJobFromGamsLib(String); GAMSWorkspace.addJobFromTestLib(String); GAMSWorkspace.addJobFromDataLib(String); GAMSWorkspace.addJobFromFinLib(String); GAMSWorkspace.addJobFromEmpLib(String); GAMSWorkspace.addJobFromFile(String); GAMSWorkspace.addJobFromFile(String, String); GAMSWorkspace.addJobFromFile(String, GAMSCheckpoint, String); GAMSWorkspace.addJobFromString(String); GAMSWorkspace.addJobFromString(String, GAMSCheckpoint); GAMSWorkspace.addJobFromString(String, GAMSCheckpoint, String)

Member Function Documentation

◆ getFileName()

String com.gams.api.GAMSJob.getFileName ( )

Retrieve the file name associated to GAMSJob.

Returns: String described the file name of GAMSJob

◆ getJobName()

String com.gams.api.GAMSJob.getJobName ( )

Retrieve the name of GAMSJob.

Returns: String described the name of GAMSJob

◆ interrupt()

boolean com.gams.api.GAMSJob.interrupt ( )

Send interrupt message to GAMS during GAMSJob instance executes its run method.

This method is useful for interrupting the long running GAMSJob.

Exceptions

GAMSException If GAMSJob instance could not be successfully interrupted

Returns: true if GAMS has acknowledged an interrupt message, false otherwise.

◆ OutDB()

GAMSDatabase com.gams.api.GAMSJob.OutDB ( )

Retrieve GAMSDatabase created by Run method.

Returns: Reference to GAMSDatabasae instance

◆ run() [1/32]

void com.gams.api.GAMSJob.run ( )

Run GAMSJob.

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [2/32]

void com.gams.api.GAMSJob.run ( boolean createOutDB )

Run GAMSJob will create an output GAMSDatabase by default.

This method allows to suppress the GAMSDatabase creation by setting createOutDB flag to false.

Parameters

createOutDB Flag determined if OutDB should be created

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [3/32]

void com.gams.api.GAMSJob.run	(	boolean	createOutDB,
		GAMSDatabase ...	databases
	)

Run GAMSJob with existing GAMSDatabase(s), also set flag to determine if OutDB should be created (true by default).

Parameters

createOutDB	Flag determined if OutDB should be created
databases	Arbitrary arguments of GAMS databases

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [4/32]

void com.gams.api.GAMSJob.run ( GAMSCheckpoint checkpoint )

Run GAMSJob with GAMSCheckpoint.

Parameters

checkpoint GAMSCheckpoint to be created by GAMSJob

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [5/32]

void com.gams.api.GAMSJob.run	(	GAMSCheckpoint	checkpoint,
		boolean	createOutDB
	)

Run GAMSJob with GAMSCheckpoint and set flag to determine if OutDB should be created (true by default).

Parameters

checkpoint	GAMSCheckpoint to be created by GAMSJob
createOutDB	Flag determined if OutDB should be created

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [6/32]

void com.gams.api.GAMSJob.run	(	GAMSCheckpoint	checkpoint,
		boolean	createOutDB,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSCheckpoint and existing GAMSDatabase(s), also set flag to determine if OutDB should be created (true by default).

Parameters

checkpoint	GAMSCheckpoint to be created by GAMSJob
createOutDB	Flag determined if OutDB should be created
databases	Arbitrary arguments of GAMS databases read by GAMSJob

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [7/32]

void com.gams.api.GAMSJob.run	(	GAMSCheckpoint	checkpoint,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSCheckpoint and existing GAMSDatabase(s).

Parameters

checkpoint	GAMSCheckpoint to be created by GAMSJob
databases	Arbitrary arguments of GAMS databases read by GAMSJob

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [8/32]

void com.gams.api.GAMSJob.run	(	GAMSCheckpoint	checkpoint,
		PrintStream	output
	)

Run GAMSJob with GAMSCheckpoint and use java.io.PrintStream to capture GAMS log.

Parameters

checkpoint	GAMSCheckpoint to be created by GAMSJob
output	Stream to capture GAMS log

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [9/32]

void com.gams.api.GAMSJob.run	(	GAMSCheckpoint	checkpoint,
		PrintStream	output,
		boolean	createOutDB,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSCheckpoint and existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log and set flag to determine if OutDB should be created (true by default).

Parameters

checkpoint	GAMSCheckpoint to be created by GAMSJob
output	Stream to capture GAMS log
createOutDB	Flag determined if OutDB should be created
databases	Arbitrary arguments of GAMS databases

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [10/32]

void com.gams.api.GAMSJob.run	(	GAMSCheckpoint	checkpoint,
		PrintStream	output,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSCheckpoint and existing GAMSDatabase(s),
also use java.io.PrintStream to capture GAMS log.

Parameters

checkpoint	GAMSCheckpoint to be created by GAMSJob
output	Stream to capture GAMS log
databases	Arbitrary arguments of GAMS databases read by GAMSJob

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [11/32]

void com.gams.api.GAMSJob.run ( GAMSDatabase ... databases )

Run GAMSJob with existing GAMSDatbase(s).

Parameters

databases Arbitrary argument of GAMS databases

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [12/32]

void com.gams.api.GAMSJob.run ( GAMSOptions options )

Run GAMSJob with GAMSOptions.

Parameters

options GAMS options to control job

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [13/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		boolean	createOutDB
	)

Run GAMSJob with GAMSOptions and use flag to determine if OutDB should be created during the run (true by default).

Parameters

options	GAMS options to control job
createOutDB	Flag determined if OutDB should be created

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [14/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		boolean	createOutDB,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSOptions, existing GAMSDatabase(s), and set Flag determined if OutDB should be created (true by default).

Parameters

options	GAMS options to control job
createOutDB	Flag determined if OutDB should be created
databases	Arbitrary arguments of GAMS databases

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [15/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		GAMSCheckpoint	checkpoint
	)

Run GAMSJob with GAMSOptions and GAMSCheckpoint.

Parameters

options	GAMS options to control job
checkpoint	GAMSCheckpoint to be created by GAMSJob

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [16/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		GAMSCheckpoint	checkpoint,
		boolean	createOutDB
	)

Run GAMSJob with GAMSOptions, GAMSCheckpoint, and flag to determine if OutDB should be created (true by default).

Parameters

options	GAMS options to control job
checkpoint	GAMSCheckpoint to be created by GAMSJob
createOutDB	Flag determined if OutDB should be created

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [17/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		GAMSCheckpoint	checkpoint,
		boolean	createOutDB,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSOptions, GAMSCheckpoint, and existing GAMSDatabase(s);
also set flag determined if OutDB should be created (true by default).

Parameters

options	GAMS options to control job
checkpoint	GAMSCheckpoint to be created by GAMSJob
createOutDB	Flag determined if OutDB should be created
databases	Arbitrary arguments of GAMS databases

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [18/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		GAMSCheckpoint	checkpoint,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSOptions, GAMSCheckpoint, and existing GAMSDatabase(s).

Parameters

options	GAMS options to control job
checkpoint	GAMSCheckpoint to be created by GAMSJob
databases	Arbitrary arguments of GAMS databases

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [19/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		GAMSCheckpoint	checkpoint,
		PrintStream	output
	)

Run GAMSJob with GAMSOptions and GAMSCheckpoint, also use java.io.PrintStream to capture GAMS log.

Parameters

options	GAMS options to control job
checkpoint	GAMSCheckpoint to be created by GAMSJob
output	Stream to capture GAMS log

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [20/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		GAMSCheckpoint	checkpoint,
		PrintStream	output,
		boolean	createOutDB
	)

Run GAMSJob with GAMSOptions and GAMSCheckpoint, also use java.io.PrintStream to capture GAMS log and set flag determined if OutDB should be created (true by default).

Parameters

options	GAMS options to control job
checkpoint	GAMSCheckpoint to be created by GAMSJob
output	Stream to capture GAMS log
createOutDB	Flag determined if OutDB should be created

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [21/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		GAMSCheckpoint	checkpoint,
		PrintStream	output,
		boolean	createOutDB,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSOptions, GAMSCheckpoint, and existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log and set flag determined if OutDB should be created (true by default).

Parameters

options	GAMS options to control job
checkpoint	GAMSCheckpoint to be created by GAMSJob
output	Stream to capture GAMS log
createOutDB	Flag determined if OutDB should be created
databases	Arbitrary arguments of GAMS databases read by GAMSJob

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [22/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		GAMSCheckpoint	checkpoint,
		PrintStream	output,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSOptions, GAMSCheckpoint, and existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log.

Parameters

options	GAMS options to control job
checkpoint	GAMSCheckpoint to be created by GAMSJob
output	Stream to capture GAMS log
databases	Arbitrary arguments of GAMS databases read by GAMSJob

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessages

◆ run() [23/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSOptions and existing GAMSDatbase(s).

Parameters

options	GAMS options to control job
databases	Arbitrary arguments of GAMS databases

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [24/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		PrintStream	output
	)

Run GAMSJob with GAMSOptions and use java.io.PrintStream to capture GAMS log.

Parameters

options	GAMS options to control job
output	Stream to capture GAMS log

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [25/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		PrintStream	output,
		boolean	createOutDB
	)

Run GAMSJob with GAMSOptions, also use java.io.PrintStream to capture GAMS log and use createOutDB flag to determine if OutDB should be created during the run (true by default).

Parameters

options	GAMS options to control job
output	Stream to capture GAMS log
createOutDB	Flag determined if OutDB should be created

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [26/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		PrintStream	output,
		boolean	createOutDB,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSOptions and existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log and set flag determined if OutDB should be created (true by default).

Parameters

options	GAMS options to control job
output	Stream to capture GAMS log
createOutDB	Flag determined if OutDB should be created
databases	Arbitrary arguments of GAMS databases

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [27/32]

void com.gams.api.GAMSJob.run	(	GAMSOptions	options,
		PrintStream	output,
		GAMSDatabase ...	databases
	)

Run GAMSJob with GAMSOptions, existing GAMSDatabase(s), and use java.io.PrintStream to capture GAMS log.

Parameters

options	GAMS options to control job
output	GAMSCheckpoint to be created by GAMSJob
databases	Arbitrary arguments of GAMS databases

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [28/32]

void com.gams.api.GAMSJob.run ( GAMSRunParameters parameters )

Run GAMSJob with GAMSRunParameters.

Parameters

parameters GAMSRunPrameters to control the engine job

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

◆ run() [29/32]

void com.gams.api.GAMSJob.run ( PrintStream output )

Run GAMSJob and use java.io.PrintStream to capture GAMS log.

Parameters

output Stream to capture GAMS log

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [30/32]

void com.gams.api.GAMSJob.run	(	PrintStream	output,
		boolean	createOutDB
	)

Run GAMSJob and use java.io.PrintStream to capture GAMS log also set flag to determine if OutDB should be created (true by default).

Parameters

output	Stream to capture GAMS log
createOutDB	Flag determined if OutDB should be created

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [31/32]

void com.gams.api.GAMSJob.run	(	PrintStream	output,
		boolean	createOutDB,
		GAMSDatabase ...	databases
	)

Run GAMSJob with existing GAMSDatabase(s), also use java.io.PrintStream to capture GAMS log and set flag to determine if OutDB should be created (true by default).

Parameters

output	Stream to capture GAMS log
createOutDB	Flag determined if OutDB should be created
databases	Arbitrary arguments of GAMS databases read by GAMSJob

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ run() [32/32]

void com.gams.api.GAMSJob.run	(	PrintStream	output,
		GAMSDatabase ...	databases
	)

Run GAMSJob with existing GAMSDatabase(s) and use java.io.PrintStream to capture GAMS log.

Parameters

output	Stream to capture GAMS log
databases	Arbitrary arguments of GAMS databases read by GAMSJob

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

See also: GAMSGlobals.ExitCodeMessage

◆ runEngine()

void com.gams.api.GAMSJob.runEngine ( GAMSEngineRunParameters parameters )

Run Engine Job with GAMSEngineRunParameters.

Parameters

parameters GAMSEngineRunPrameters to control the engine job

Exceptions

GAMSException	If GAMSJob instance could not be successfully executed
GAMSExecutionException	If GAMSJob has been executed and terminated with an error (exit code != 0)

Public Member Functions

Detailed Description

Member Function Documentation

◆ getFileName()

◆ getJobName()

◆ interrupt()

◆ OutDB()

◆ run() [1/32]

◆ run() [2/32]

◆ run() [3/32]

◆ run() [4/32]

◆ run() [5/32]

◆ run() [6/32]

◆ run() [7/32]

◆ run() [8/32]

◆ run() [9/32]

◆ run() [10/32]

◆ run() [11/32]

◆ run() [12/32]

◆ run() [13/32]

◆ run() [14/32]

◆ run() [15/32]

◆ run() [16/32]

◆ run() [17/32]

◆ run() [18/32]

◆ run() [19/32]

◆ run() [20/32]

◆ run() [21/32]

◆ run() [22/32]

◆ run() [23/32]

◆ run() [24/32]

◆ run() [25/32]

◆ run() [26/32]

◆ run() [27/32]

◆ run() [28/32]

◆ run() [29/32]

◆ run() [30/32]

◆ run() [31/32]

◆ run() [32/32]

◆ runEngine()