com.gams.api.GAMSSet Class Reference

This is the representation of a set symbol in GAMS. More...

Inheritance diagram for com.gams.api.GAMSSet:
com.gams.api.GAMSSymbol< GAMSSetRecord >

Additional Inherited Members

- Public Member Functions inherited from com.gams.api.GAMSSymbol< GAMSSetRecord >
getFirstRecord ()
 Get the first record of GAMSSymbol. More...
 
getFirstRecord (String ... slice)
 Retrieve the first record in GAMSSymbol that meets the slice criteria. More...
 
getLastRecord ()
 Get the last record of GAMSSymbol. More...
 
getLastRecord (String ... slice)
 Retrieve the last record in GAMSSymbol that meets the slice criteria. More...
 
findRecord (String ... keys)
 Find record in GAMSSymbol. More...
 
addRecord (Vector< String > keys)
 Add record T to GAMSSymbol. More...
 
addRecord (String ... keys)
 Add record T to GAMSSymbol. More...
 
mergeRecord (String ... keys)
 Find record T with specified keys in GAMSSymbol. More...
 
boolean deleteRecord (String ... keys)
 Delete record T from GAMSSymbol. More...
 
boolean clear ()
 Clear symbol. More...
 
void compact ()
 
void copySymbol (GAMSSymbol<?> target)
 Copy all records of this GAMSSymbol to target GAMSSymbol (if target had records, they will be deleted) More...
 
GAMSDatabase getDatabase ()
 Get GAMSDatabase containing GAMSSymbol. More...
 
int getDimension ()
 Get GAMSSymbol dimension. More...
 
String getName ()
 Get GAMSSymbol name. More...
 
String getText ()
 Get GAMSSymbol explanatory text. More...
 
int getNumberOfRecords ()
 Get the number of records of the GAMSSymbol. More...
 
List< Object > getDomains ()
 Retrieve domains of Symbol, each element is either a GAMSSet (real domain) or a String (relaxed domain). More...
 
List< String > getDomainsAsStrings ()
 Retrieve domains of Symbol, each element is a string. More...
 
boolean checkDomains ()
 Check all GAMSSymbolRecord instances of the symbol if all their records are within the specified domain of the symbol. More...
 
List< GAMSSymbolDomainViolationgetSymbolDomainViolations (int maxNoViolation)
 Check all GAMSSymbolRecord instances in the Symbol if they are within the specified domain of the symbol. More...
 
Iterator< T > iterator ()
 Returns an iterator over a set of elements of type T. More...
 
- Protected Member Functions inherited from com.gams.api.GAMSSymbol< GAMSSetRecord >
 GAMSSymbol (GAMSDatabase database, long sPtr)
 Create a GAMS Symbol instance. More...
 
 GAMSSymbol (GAMSDatabase database, String identifier, int dimension, String explanatoryText)
 Create a GAMS Symbol instance. More...
 
abstract T CheckAndReturnRecord (long symIterPtr)
 This method checks if symbol pointer is valid. More...
 

Detailed Description

This is the representation of a set symbol in GAMS.

It exists in a GAMSDatabase and contains GAMSSetRecords which one can iterate through.

See also
GAMSDatabase
GAMSDatabase.addSet(String, int)
GAMSDatabase.addSet(String, int, String)
GAMSDatabase.addSet(String, String, Object...)