com.gams.api.GAMSCheckpoint Class Reference

An instance of GAMSCheckpoint captures the state of a GAMSJob after the GAMSJob.run() method has been carried out, and can be created via the call of methods. More...

Public Member Functions

GAMSWorkspace cpWorkspace ()
 Get the GAMSWorkspace. More...
 
String cpName ()
 Get the checkpoint name. More...
 
String cpFileName ()
 Get the checkpoint file name (extension .g00) More...
 
GAMSModelInstance addModelInstance ()
 Create model instance. More...
 
GAMSModelInstance addModelInstance (String modelInstanceName)
 Create model instance. More...
 

Detailed Description

An instance of GAMSCheckpoint captures the state of a GAMSJob after the GAMSJob.run() method has been carried out, and can be created via the call of methods.

Another GAMSJob can continue (or restart) from a GAMSCheckpoint. A GAMSCheckpoint constructed with a file name will create a file (extension .g00) for permanent storage when supplied as parameter on the GAMSJob.run() method. Moreover, a GAMSModelInstance is also initialized from a checkpoint that contains the model definition of the model instance.

See also
GAMSJob
GAMSModelInstance
GAMSWorkspace
GAMSWorkspace.addCheckpoint()
GAMSWorkspace.addCheckpoint(String)

Member Function Documentation

◆ addModelInstance() [1/2]

GAMSModelInstance com.gams.api.GAMSCheckpoint.addModelInstance ( )

Create model instance.

The name of a GAMSModelInstance object is generated automatically.

Returns
Reference to GAMSModelInstance object

◆ addModelInstance() [2/2]

GAMSModelInstance com.gams.api.GAMSCheckpoint.addModelInstance ( String  modelInstanceName)

Create model instance.

Parameters
modelInstanceNamethe name of GAMSModelInstance instance.
Returns
Reference to GAMSModelInstance instance

◆ cpFileName()

String com.gams.api.GAMSCheckpoint.cpFileName ( )

Get the checkpoint file name (extension .g00)

Returns
The file name of GAMSCheckpoint instance

◆ cpName()

String com.gams.api.GAMSCheckpoint.cpName ( )

Get the checkpoint name.

Returns
The name of GAMSCheckpoint instance

◆ cpWorkspace()

GAMSWorkspace com.gams.api.GAMSCheckpoint.cpWorkspace ( )

Get the GAMSWorkspace.

Returns
Reference to GAMSWorkspace instance