This is the representation of a variable symbol in GAMS. It exists in a GAMSDatabase and contains GAMSVariableRecords which one can iterate through. More...

Inheritance diagram for GAMS.GAMSVariable:

Public Member Functions
new GAMSVariableRecord	AddRecord (params string[] keys)
	Add record to GAMSVariable.

new GAMSVariableRecord	FindRecord (params string[] keys)
	Find record in GAMSVariable.

new GAMSVariableRecord	MergeRecord (params string[] keys)
	Finds record in GAMSVariable if it exists, adds it if not.

new GAMSVariableRecord	FirstRecord ()
	Retrieve first record in GAMSVariable.

new GAMSVariableRecord	FirstRecord (params string[] slice)
	Retrieve a slice of the first record in GAMSVariable.

new GAMSVariableRecord	LastRecord ()
	Retrieve last record in GAMSVariable.

new GAMSVariableRecord	LastRecord (params string[] slice)
	Retrieve a slice of the last record in GAMSVariable.

Public Member Functions inherited from GAMS.GAMSSymbol
bool	DeleteRecord (params string[] keys)
	Delete GAMSSymbol record.

bool	Clear ()
	Clear symbol.

bool	CheckDomains ()
	Check if all records are within the specified domain of the symbol.

List< GAMSSymbolDomainViolation >	GetSymbolDVs (int MaxViol=0)
	Return all GAMSSymbolDomainViolations.

GAMSSymbolRecord	AddRecord (params string[] keys)
	Add record to GAMSSymbol.

GAMSSymbolRecord	FindRecord (params string[] keys)
	Find record in GAMSSymbol.

GAMSSymbolRecord	MergeRecord (params string[] keys)
	Finds record in GAMSSymbol if it exists, adds it if not.

GAMSSymbolRecord	FirstRecord ()
	Retrieve first record in GAMSSymbol.

GAMSSymbolRecord	FirstRecord (params string[] slice)
	Retrieve the first record in GAMSSymbol that meets the slice criteria.

GAMSSymbolRecord	LastRecord ()
	Retrieve last record in GAMSSymbol.

GAMSSymbolRecord	LastRecord (params string[] slice)
	Retrieve a slice of the last record in GAMSSymbol.

void	CopySymbol (GAMSSymbol target)
	Copys all records of this GAMSSymbol to target GAMSSymbol (if target had records, they will be deleted)

void	CopyToArray (object cube, int field=gamsglobals.val_level)
	Copies values of a dense symbol into a dense array If the symbol is a set, the position of each record within the set is stored (1-based). If the symbol is a parameter the value is stored. If the symbol is an equation or a variable the parameter field determines what is stored.

int	CopyToSqzdArray (object cube, int field, params Tuple< GAMSSet, GAMSSet >[] domains)
	Copies values of a sparse symbol into a squeezed array If the symbol is a set, the position of each record within the set is stored (1-based). If the symbol is a parameter the value is stored. If the symbol is an equation or a variable the parameter field determines what is stored.

int	CopyToSqzdArray (object cube, params Tuple< GAMSSet, GAMSSet >[] domains)
	Copies values of a sparse symbol into a squeezed array If the symbol is a set, the position of each record within the set is stored (1-based). If the symbol is a parameter the value is stored. If the symbol is an equation or a variable the level is stored.

int	CopySparseToDenseArray (object cube, int field, params GAMSSet[] domains)
	Copies values of a sparse symbol into a dense array If the symbol is a set, the position of each record within the set is stored (1-based). If the symbol is a parameter the value is stored. If the symbol is an equation or a variable the parameter field determines what is stored.

int	CopySparseToDenseArray (object cube, params GAMSSet[] domains)
	Copies values of a sparse symbol into a squeezed array If the symbol is a set, the position of each record within the set is stored (1-based). If the symbol is a parameter the value is stored. If the symbol is an equation or a variable the level is stored.

void	CopyFromDenseArray (object cube, params GAMSSet[] domains)
	Copies values from dense array into a symbol If the symbol is a set, the defined records are added. If the symbol is a parameter, the defined records are added and the values are set. If the symbol is an equation or a variable, the defined records are added and the levels are set.111.

void	CopySliceFromDenseArray (object cube, params Tuple< GAMSSet, GAMSSet >[] domains)
	Copies values from slice of dense array into a symbol If the symbol is a set, the defined records are added. If the symbol is a parameter, the defined records are added and the values are set. If the symbol is an equation or a variable, the defined records are added and the levels are set.111.

override bool	Equals (object obj)
	Indicates whether another object is "equal to" this one. This is the case if they hold the same Symbol Pointer (aka the same internal reference).

override int	GetHashCode ()
	Calculates a Hash Code based on the Sympol Pointer (aka the internal reference).

bool	Equals (GAMSSymbol s)
	Indicates whether another GAMSSymbol is "equal to" this one. This is the case if they hold the same Symbol Pointer (aka the same internal reference).

GAMSSymbolEnumerator	GetEnumerator ()
	Retrieve an enumerator for this symbol.

Properties
VarType	VarType `[get]`
	Retrieve subtype of variable (Binary, Integer, Positive, Negative, Free, SOS1, SOS2, SemiCont, SemiInt,)

Properties inherited from GAMS.GAMSSymbol
GAMSDatabase	GAMSDatabase `[get]`
	Get GAMSDatabase containing GAMSSymbol.

string	Name `[get]`
	Get GAMSSymbol name.

int	Dim `[get]`
	Get GAMSSymbol dimension.

string	Text `[get]`
	Get explanatory text of GAMSSymbol.

int	NumberRecords `[get]`
	Retrieve the number of records of the GAMSSymbol.

List< object >	Domains `[get]`
	Domains of Symbol, each element is either a GAMSSet (real domain) or a string (relaxed domain)

List< string >	DomainsAsStrings `[get]`
	Domains of Symbol, each element is a string Note: If the domain is an alias in GAMS, this call will return the name of the Alias, not the name of the aliased Set.

Additional Inherited Members
Static Public Member Functions inherited from GAMS.GAMSSymbol
static bool	operator== (GAMSSymbol lhs, GAMSSymbol rhs)
	Indicate whether two GAMSSybols are equal to each other. This is the case if they hold the same Symbol Pointer (aka the same internal reference).

static bool	operator!= (GAMSSymbol lhs, GAMSSymbol rhs)
	Indicate whether two GAMSSybols are not equal to each other. This is the case if they hold different Symbol Pointer (aka different internal references).

Protected Member Functions inherited from GAMS.GAMSSymbol
	GAMSSymbol (GAMSDatabase database, IntPtr symPtr)
	Constructor.

	GAMSSymbol (GAMSDatabase database, string identifier, int dimension, string explanatoryText)
	Constructor.

Package Functions inherited from GAMS.GAMSSymbol
Package Attributes inherited from GAMS.GAMSSymbol

Detailed Description

This is the representation of a variable symbol in GAMS. It exists in a GAMSDatabase and contains GAMSVariableRecords which one can iterate through.

Member Function Documentation

◆ AddRecord()

new GAMSVariableRecord GAMS.GAMSVariable.AddRecord ( params string[] keys )

inline

Add record to GAMSVariable.

Parameters

keys	List of keys

Returns: Reference to added record

◆ FindRecord()

new GAMSVariableRecord GAMS.GAMSVariable.FindRecord ( params string[] keys )

inline

Find record in GAMSVariable.

Parameters

keys	List of keys

Returns: Reference to found record

◆ FirstRecord() [1/2]

new GAMSVariableRecord GAMS.GAMSVariable.FirstRecord ( )

inline

Retrieve first record in GAMSVariable.

Returns: Reference to record

◆ FirstRecord() [2/2]

new GAMSVariableRecord GAMS.GAMSVariable.FirstRecord ( params string[] slice )

inline

Retrieve a slice of the first record in GAMSVariable.

Parameters

slice Define filter for elements whose record should be retrieved

Returns: Reference to record

◆ LastRecord() [1/2]

new GAMSVariableRecord GAMS.GAMSVariable.LastRecord ( )

inline

Retrieve last record in GAMSVariable.

Returns: Reference to record

◆ LastRecord() [2/2]

new GAMSVariableRecord GAMS.GAMSVariable.LastRecord ( params string[] slice )

inline

Retrieve a slice of the last record in GAMSVariable.

Parameters

slice Define filter for elements whose record should be retrieved

Returns: Reference to record

◆ MergeRecord()

new GAMSVariableRecord GAMS.GAMSVariable.MergeRecord ( params string[] keys )

inline

Finds record in GAMSVariable if it exists, adds it if not.

Parameters

keys	List of keys

Returns: Reference to added record

Property Documentation

◆ VarType

VarType GAMS.GAMSVariable.VarType

get

Retrieve subtype of variable (Binary, Integer, Positive, Negative, Free, SOS1, SOS2, SemiCont, SemiInt,)

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddRecord()

◆ FindRecord()

◆ FirstRecord() [1/2]

◆ FirstRecord() [2/2]

◆ LastRecord() [1/2]

◆ LastRecord() [2/2]

◆ MergeRecord()

Property Documentation

◆ VarType