Matlab.GAMS.GAMSCheckpoint Class Reference

Captures the state of a GAMSJob after the GAMSJob.run method has been carried out. More...

Public Member Functions

GAMSModelInstance addModelInstance (varargin)
 Create model instance. More...
 

Public Attributes

string fileName
 (read only) Checkpoint file name (extension .g00)
 
string name
 (read only) Checkpoint name
 
GAMSWorkspace workspace
 (read only) Reference to GAMSWorkspace instance
 

Detailed Description

Captures the state of a GAMSJob after the GAMSJob.run method has been carried out.

A GAMSCheckpoint can be created via the call of GAMSWorkspace.addCheckpoint method. 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

Member Function Documentation

◆ addModelInstance()

GAMSModelInstance Matlab.GAMS.GAMSCheckpoint.addModelInstance ( varargin  )

Create model instance.

If modelInstanceName is not given, the name of a GAMSModelInstance object is generated automatically.

Valid VARARGIN signatures:

  • [ ]
  • string modelInstanceName

Arguments:

Return: Reference to GAMSModelInstance instance