22.04.2013 Views

GAMS Data Exchange API

GAMS Data Exchange API

GAMS Data Exchange API

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

TGXFileObj<br />

Page 34<br />

See Also<br />

TGXFileObj.gdxAcronymSetInfo ( see page 35), TGXFileObj.gdxAcronymCount ( see page 33)<br />

TGXFileObj.gdxAcronymGetMapping<br />

Get information how acronym values are remapped<br />

function gdxAcronymGetMapping(N: integer; var orgIndx: integer; var newIndx: integer; var<br />

autoIndex: integer): integer;<br />

Parameters<br />

N: integer<br />

Index into acronym table; range from 1 to AcronymCount<br />

var orgIndx: integer<br />

The Index used in the gdx file<br />

var newIndx: integer<br />

The Index returned when reading gdx data<br />

var autoIndex: integer<br />

non-zero if the newIndx was generated using the value of NextAutoAcronym<br />

Return Value<br />

Non-zero if the index into the acronym table is valid; false otherwise<br />

Description<br />

When reading gdx data, we need to map indices for acronyms used in the gdx file to indices used by the reading program. There<br />

is a problen when not all acronyms have been registered before reading the gdx data. We need to map an udefined index we<br />

read to a new value. The value of NextAutoAcronym is used for that.<br />

See Also<br />

TGXFileObj.gdxAcronymGetInfo ( see page 33), TGXFileObj.gdxAcronymCount ( see page 33),<br />

TGXFileObj.gdxAcronymNextNr ( see page 35)<br />

TGXFileObj.gdxAcronymIndex<br />

Get index value of an acronym<br />

function gdxAcronymIndex(V: double): integer;<br />

Parameters<br />

V: double<br />

Input value possibly representing an acronym<br />

Return Value<br />

Index of acronym value V; zero if V does not represent an acronym<br />

See Also<br />

TGXFileObj.gdxAcronymValue ( see page 35)<br />

TGXFileObj.gdxAcronymName<br />

Find the name of an acronym value<br />

function gdxAcronymName(V: double; var AName: ShortString): integer;<br />

Parameters<br />

V: double<br />

Input value possibly containing an acronym<br />

var AName: ShortString<br />

Name of acronym value or the empty string<br />

Symbol Reference Classes <strong>GAMS</strong> <strong>Data</strong> <strong>Exchange</strong> <strong>API</strong><br />

2.1<br />

Page 34 2.4<br />

12/3/2012

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!