Instances of this class are input to GAMSModelInstance.instantiate method.
More...
Public Member Functions | |
| GAMSModifier (GAMSSymbol<?> gamsSymbol, GAMSGlobals.UpdateAction updateAction, GAMSParameter dataSymbol) | |
| Constructs a new GAMSModifier instance. | |
| GAMSModifier (GAMSSymbol<?> gamsSymbol, GAMSGlobals.UpdateAction updateAction, GAMSParameter dataSymbol, GAMSModelInstance.SymbolUpdateType updateType) | |
| Constructs a new GAMSModifier instance. | |
| GAMSModifier (GAMSParameter gamsParam) | |
| Constructs a new GAMSModifier instance. | |
| GAMSModifier (GAMSParameter gamsParam, GAMSModelInstance.SymbolUpdateType updateType) | |
| Constructs a new GAMSModifier instance. | |
| GAMSSymbol<?> | getGamsSymbol () |
Get GAMSSymbol instance in the GAMS model to be modified. | |
| GAMSGlobals.UpdateAction | getUpdAction () |
| Get type of modification. | |
| GAMSParameter | getDataSymbol () |
| Get Symbol containing the data for the modification.s. | |
| GAMSModelInstance.SymbolUpdateType | getUpdateType () |
| Get Symbol Update Type. | |
Detailed Description
Instances of this class are input to GAMSModelInstance.instantiate method.
A GAMSModifier consists either of a GAMSParameter or a triple: A GAMSVariable or GAMSEquation to be modified, the modification action (e.g. Upper, Lower or Fixed for updating bounds of a variable, or Primal/Dual for updating the level/marginal of a variable or equation mainly used for starting non-linear models from different starting points), and a GAMSParameter that holds the data for modification. In addition the UpdateType can be defined (if omitted the type defined in the Solve call is used).
- See also
- GAMSModelInstance
Constructor & Destructor Documentation
◆ GAMSModifier() [1/4]
| com.gams.api.GAMSModifier.GAMSModifier | ( | GAMSSymbol<?> | gamsSymbol, |
| GAMSGlobals.UpdateAction | updateAction, | ||
| GAMSParameter | dataSymbol | ||
| ) |
Constructs a new GAMSModifier instance.
- Parameters
-
gamsSymbol Symbol in the GAMS model to be modified updateAction Modification action dataSymbol Parameter containing the data for the modification
- Exceptions
-
GAMSException If GAMSModifier object could not be successfully created
- See also
- GAMSGlobals.UpdateAction
- GAMSModelInstance
- GAMSSymbol
◆ GAMSModifier() [2/4]
| com.gams.api.GAMSModifier.GAMSModifier | ( | GAMSSymbol<?> | gamsSymbol, |
| GAMSGlobals.UpdateAction | updateAction, | ||
| GAMSParameter | dataSymbol, | ||
| GAMSModelInstance.SymbolUpdateType | updateType | ||
| ) |
Constructs a new GAMSModifier instance.
- Parameters
-
gamsSymbol Symbol in the GAMS model to be modified updateAction Modification action dataSymbol Parameter containing the data for the modification updateType Modification type
- Exceptions
-
GAMSException If GAMSModifier object could not be successfully created
- See also
- GAMSGlobals.UpdateAction
- GAMSModelInstance
- GAMSModelInstance.SymbolUpdateType
- GAMSSymbol
◆ GAMSModifier() [3/4]
| com.gams.api.GAMSModifier.GAMSModifier | ( | GAMSParameter | gamsParam | ) |
Constructs a new GAMSModifier instance.
- Parameters
-
gamsParam Parameter in the GAMS model to be modified with data for modification
◆ GAMSModifier() [4/4]
| com.gams.api.GAMSModifier.GAMSModifier | ( | GAMSParameter | gamsParam, |
| GAMSModelInstance.SymbolUpdateType | updateType | ||
| ) |
Constructs a new GAMSModifier instance.
- Parameters
-
updateType Modification type gamsParam Parameter in the GAMS model to be modified with data for modification
- See also
- GAMSModelInstance
- GAMSModelInstance.SymbolUpdateType
Member Function Documentation
◆ getDataSymbol()
| GAMSParameter com.gams.api.GAMSModifier.getDataSymbol | ( | ) |
Get Symbol containing the data for the modification.s.
- Returns
GAMSParameterinstance
◆ getGamsSymbol()
| GAMSSymbol<?> com.gams.api.GAMSModifier.getGamsSymbol | ( | ) |
Get GAMSSymbol instance in the GAMS model to be modified.
- Returns
- GAMSSymbol instance
- See also
- GAMSSymbol
◆ getUpdAction()
| GAMSGlobals.UpdateAction com.gams.api.GAMSModifier.getUpdAction | ( | ) |
Get type of modification.
- Returns
- type of modification.
- See also
- GAMSGlobals.UpdateAction
◆ getUpdateType()
| GAMSModelInstance.SymbolUpdateType com.gams.api.GAMSModifier.getUpdateType | ( | ) |
Get Symbol Update Type.
- Returns
- update type
- See also
- GAMSModelInstance.SymbolUpdateType