Representation of a single record of a Symbol instance. More...

Inheritance diagram for matlab.gams.control.SymbolRecord:

Public Member Functions
void	dispose ()
	Release external resources hold by non-java library.

logical	equals (any object)
	Indicates whether some other object is "equal to" this one.

integer	hashCode ()
	Returns a hash code value for the object.

logical	isDisposed ()
	Inquire if this record has already been disposed.

string	key (integer index)
	Retrieve key of SymbolRecord on position index.

logical	moveNext ()
	Iterate to next SymbolRecord of Symbol using the current criterion.

logical	movePrevious ()
	Iterate to previous SymbolRecord of Symbol using the current criterion.

Public Attributes
cell	keys
	(read only) keys of this SymbolRecord

Detailed Description

Representation of a single record of a Symbol instance.

Derived classes are EquationRecord, ParameterRecord, SetRecord and VariableRecord.

See also: Symbol, Symbol.findRecord, Symbol.mergeRecord, Symbol.addRecord, Symbol.deleteRecord, Symbol.getFirstRecord, Symbol.getLastRecord, utils.Iterator.next, utils.Iterator.remove

Member Function Documentation

◆ dispose()

void matlab.gams.control.SymbolRecord.dispose ( )

Release external resources hold by non-java library.

A subsequent call on the object after disposed potentially causes an unexpected error or exception. Call this method either when the object is no longer needed and/or when resource management is a critical issue in the application.

◆ equals()

logical matlab.gams.control.SymbolRecord.equals ( any object )

Indicates whether some other object is "equal to" this one.

The two SymbolRecord instances are equivalent if and only if they are records of the same symbol and same internal reference.

Arguments:

object: the reference object with which to compare

Return: true if this object is the same as the obj argument, false otherwise

◆ hashCode()

integer matlab.gams.control.SymbolRecord.hashCode ( )

Returns a hash code value for the object.

Return: a hash code value for the object

◆ isDisposed()

logical matlab.gams.control.SymbolRecord.isDisposed ( )

Inquire if this record has already been disposed.

Return: true if disposed, false otherwise

◆ key()

string matlab.gams.control.SymbolRecord.key ( integer index )

Retrieve key of SymbolRecord on position index.

Arguments:

index: Index position of key to be returned

Return: Key a position index

◆ moveNext()

logical matlab.gams.control.SymbolRecord.moveNext ( )

Iterate to next SymbolRecord of Symbol using the current criterion.

In case of a specific criterion has been specified, such as retrieving record in Symbol that meets a slice criteria (Symbol.getFirstRecord) the method returns the next SymbolRecord that also meets the criteria. Otherwise the method returns the next sequential SymbolRecord.

Return: true if successfully moved to the next record, false otherwise

See also: Symbol.getFirstRecord, Symbol.getLastRecord

◆ movePrevious()

logical matlab.gams.control.SymbolRecord.movePrevious ( )

Iterate to previous SymbolRecord of Symbol using the current criterion.

In case of a specific criterion has been specified, such as retrieving record in Symbol that meets a slice criteria (Symbol.getLastRecord) the method returns the previous SymbolRecord that also meets the criteria. Otherwise the method returns the previous sequential SymbolRecord.

Return: true if successfully moved to the previous record, false otherwise

See also: Symbol.getFirstRecord, Symbol.getLastRecord

Public Member Functions

Public Attributes