Loading...
Searching...
No Matches
com.gams.api.GAMSVariableRecord Class Reference

This is the representation of a single record of a GAMSVariable instance. More...

Inheritance diagram for com.gams.api.GAMSVariableRecord:
com.gams.api.GAMSSymbolRecord

Public Member Functions

double getLevel ()
 Retrieve the the level of this GAMSVariableRecord instance.
 
void setLevel (double value)
 Set the level of this GAMSVariableRecord instance.
 
double getMarginal ()
 Retrieve the marginal of this GAMSVariableRecord instance.
 
void setMarginal (double value)
 Set the marginal of this GAMSVariableRecord instance.
 
double getScale ()
 Retrieve the scale factor of this GAMSVariableRecord instance.
 
void setScale (double value)
 Set the scale factor of this GAMSVariableRecord instance.
 
double getLower ()
 Retrieve the lower bound of this GAMSVariableRecord instance.
 
void setLower (double value)
 Set the lower bound of this GAMSVariableRecord instance.
 
double getUpper ()
 Retrieve the upper bound of this GAMSVariableRecord instance.
 
void setUpper (double value)
 Set the upper bound of this GAMSVariableRecord instance.
 
- Public Member Functions inherited from com.gams.api.GAMSSymbolRecord
String[] getKeys ()
 Retrieve keys of this GAMSSymbolRecord instance.
 
String getKey (int index)
 Retrieve key of GAMSSymbolRecord on position index.
 
boolean equals (Object obj)
 Indicates whether some other object is "equal to" this one.
 
int hashCode ()
 Returns a hash code value for the object.
 
boolean isDisposed ()
 Inquire if this record has already been disposed.
 
void dispose ()
 Release external resources hold by non-java library.
 
boolean moveNext ()
 Iterate to next GAMSSymbolRecord of GAMSSymbol using the current criterion.
 
boolean movePrevious ()
 Iterate to previous GAMSSymbolRecord of GAMSSymbol using the current criterion.
 

Additional Inherited Members

- Protected Member Functions inherited from com.gams.api.GAMSSymbolRecord
 GAMSSymbolRecord (GAMSSymbol<?> symbol, long ptr)
 Create a new GAMSSymbolRecord instance.
 
 GAMSSymbolRecord (GAMSSymbolRecord record)
 Create a new GAMSSymbolRecord instance.
 
void finalize () throws Throwable
 Release resources used by non-java library.
 

Detailed Description

This is the representation of a single record of a GAMSVariable instance.

Member Function Documentation

◆ getLevel()

double com.gams.api.GAMSVariableRecord.getLevel ( )

Retrieve the the level of this GAMSVariableRecord instance.

Returns
the level value
Exceptions
GAMSExceptionIf this GAMSDatabase instance has already been disposed therefore resources are no longer available.

◆ getLower()

double com.gams.api.GAMSVariableRecord.getLower ( )

Retrieve the lower bound of this GAMSVariableRecord instance.

Returns
the lower bound value
Exceptions
GAMSExceptionIf this GAMSDatabase instance has already been disposed therefore resources are no longer available.

◆ getMarginal()

double com.gams.api.GAMSVariableRecord.getMarginal ( )

Retrieve the marginal of this GAMSVariableRecord instance.

Returns
the marginal value
Exceptions
GAMSExceptionIf this GAMSDatabase instance has already been disposed therefore resources are no longer available.

◆ getScale()

double com.gams.api.GAMSVariableRecord.getScale ( )

Retrieve the scale factor of this GAMSVariableRecord instance.

Returns
the scale factor value
Exceptions
GAMSExceptionIf this GAMSDatabase instance has already been disposed therefore resources are no longer available.

◆ getUpper()

double com.gams.api.GAMSVariableRecord.getUpper ( )

Retrieve the upper bound of this GAMSVariableRecord instance.

Returns
the upper bound value
Exceptions
GAMSExceptionIf this GAMSDatabase instance has already been disposed therefore resources are no longer available.

◆ setLevel()

void com.gams.api.GAMSVariableRecord.setLevel ( double  value)

Set the level of this GAMSVariableRecord instance.

Parameters
valuethe level value
Exceptions
GAMSExceptionIf this GAMSDatabase instance has already been disposed therefore resources are no longer available.

◆ setLower()

void com.gams.api.GAMSVariableRecord.setLower ( double  value)

Set the lower bound of this GAMSVariableRecord instance.

Parameters
valuethe lower bound value
Exceptions
GAMSExceptionIf this GAMSDatabase instance has already been disposed therefore resources are no longer available.

◆ setMarginal()

void com.gams.api.GAMSVariableRecord.setMarginal ( double  value)

Set the marginal of this GAMSVariableRecord instance.

Parameters
valuethe marginal value
Exceptions
GAMSExceptionIf this GAMSDatabase instance has already been disposed therefore resources are no longer available.

◆ setScale()

void com.gams.api.GAMSVariableRecord.setScale ( double  value)

Set the scale factor of this GAMSVariableRecord instance.

Parameters
valuethe scale factor value
Exceptions
GAMSExceptionIf this GAMSDatabase instance has already been disposed therefore resources are no longer available.

◆ setUpper()

void com.gams.api.GAMSVariableRecord.setUpper ( double  value)

Set the upper bound of this GAMSVariableRecord instance.

Parameters
valuethe upper bound value
Exceptions
GAMSExceptionIf this GAMSDatabase instance has already been disposed therefore resources are no longer available.