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 GAMSWorkspace.addCheckpoint() methods.
More...
Public Member Functions | |
| GAMSWorkspace | cpWorkspace () |
| Get the GAMSWorkspace. | |
| String | cpName () |
| Get the checkpoint name. | |
| String | cpFileName () |
| Get the checkpoint file name (extension .g00) | |
| GAMSModelInstance | addModelInstance () |
| Create model instance. | |
| GAMSModelInstance | addModelInstance (String modelInstanceName) |
| Create model instance. | |
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 GAMSWorkspace.addCheckpoint() 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
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
-
modelInstanceName the 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