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

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

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

Public Member Functions

double getLevel ()
 Get the level of this GAMSEquationRecord instance.
 
void setLevel (double value)
 Set the the level of this GAMSEquationRecord instance.
 
double getMarginal ()
 Get the marginal of this GAMSEquationRecord instance.
 
void setMarginal (double value)
 Set the marginal of this GAMSEquationRecord instance.
 
double getUpper ()
 Get the upper bound of this GAMSEquationRecord instance.
 
void setUpper (double value)
 Set the lower bound of this GAMSEquationRecord instance.
 
double getLower ()
 Get the lower bound of this GAMSEquationRecord instance.
 
void setLower (double value)
 Set the lower bound of this GAMSEquationRecord instance.
 
double getScale ()
 Get the scale factor of this GAMSEquationRecord instance.
 
void setScale (double value)
 Set the scale factor of this GAMSEquationRecord 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 GAMSEquation instance.

Member Function Documentation

◆ getLevel()

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

Get the level of this GAMSEquationRecord 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.GAMSEquationRecord.getLower ( )

Get the lower bound of this GAMSEquationRecord instance.

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

◆ getMarginal()

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

Get the marginal of this GAMSEquationRecord instance.

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

◆ getScale()

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

Get the scale factor of this GAMSEquationRecord instance.

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

◆ getUpper()

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

Get the upper bound of this GAMSEquationRecord instance.

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

◆ setLevel()

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

Set the the level of this GAMSEquationRecord instance.

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

◆ setLower()

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

Set the lower bound of this GAMSEquationRecord instance.

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

◆ setMarginal()

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

Set the marginal of this GAMSEquationRecord instance.

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

◆ setScale()

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

Set the scale factor of this GAMSEquationRecord instance.

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

◆ setUpper()

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

Set the lower bound of this GAMSEquationRecord instance.

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