GAMS Environment Object (GEV) Documentation

Generated for GAMS ..

Functions, Procedures, and Properties

 

Logging

Boolean gevSkipIOLegacySet
 Prevent log and status file to be opened
 

GAMS Options

Integer gevThreads
 Number of threads (1..n); if option gevThreadsRaw = 0, this function gives the number of available processors
 

Other

Double gevNSolves
 Number of solves
 

Deprecated

Integer gevInitJacLegacy
 Legacy Jacobian Evaluation: Initialize row wise Jacobian structure
 
void gevSetColRowPermLegacy
 Legacy Jacobian Evaluation: Set column and row permutation GAMS to solver
 
void gevSetJacPermLegacy
 Legacy Jacobian Evaluation: Set Jacobian permutation GAMS to solver
 
Integer gevEvalNewPointLegacy
 Legacy Jacobian Evaluation: Set new point and do point copy magic
 
Integer gevEvalJacLegacy
 Legacy Jacobian Evaluation: Evaluate row and store in Jacobian structure
 
Integer gevEvalJacLegacyX
 Legacy Jacobian Evaluation: Evaluate set of rows and store in Jacobian structure
 
Integer gevNextNLLegacy
 Legacy Jacobian Evaluation: Provide next nonlinear row, start with M
 
Integer gevRowGms2SlvLegacy
 Legacy Jacobian Evaluation: Provide permuted row index
 
void gevFreeJacLegacy
 Legacy Jacobian Evaluation: Free row wise Jacobian structure
 
Pointer gevGetALGX
 Pass pointer to ALGX structure
 

GAMS Options

Integer gevGetIntOpt
 Get integer valued option (see enumerated constants)
 
Double gevGetDblOpt
 Get double valued option (see enumerated constants)
 
ShortString gevGetStrOpt
 Get string valued option (see enumerated constants)
 
void gevSetIntOpt
 Set integer valued option (see enumerated constants)
 
void gevSetDblOpt
 Set double valued option (see enumerated constants)
 
void gevSetStrOpt
 Set string valued option (see enumerated constants)
 
void gevSynchronizeOpt
 Copy environment options to passed in option object
 

GAMS Solvers

Integer gevGetSlvExeInfo
 Name of solver executable
 
Integer gevGetSlvLibInfo
 Solver library name, prefix, and API version
 
Integer gevCapabilityCheck
 Check if solver is capable to handle model type given
 
Integer gevSolverVisibility
 Provide information if solver is hidden
 
Integer gevNumSolvers
 Number of solvers in the system
 
ShortString gevGetSolver
 Name of the solver chosen for modeltype (if non is chosen, it is the default)
 
ShortString gevGetCurrentSolver
 Name of the select solver
 
ShortString gevGetSolverDefault
 Name of the default solver for modeltype
 
Integer gevSolver2Id
 Internal ID of solver, 0 for failure
 
ShortString gevId2Solver
 Solver name
 
ShortString gevCallSolverNextGridDir
 Creates grid directory for next gevCallSolver call and returns name (if called with gevSolveLinkAsyncGrid or gevSolveLinkAsyncSimulate)
 
Integer gevCallSolver
 Call GAMS solver on GMO model or control file
 
Integer gevCallSolverHandleStatus
 Check status of solver job if called with gevSolveLinkAsyncGrid (0 job is done, 1 unknown job handle, 2 job is running)
 
Integer gevCallSolverHandleDelete
 Delete instance of solver job if called with gevSolveLinkAsyncGrid (0 deleted, 1 unknown job handle, 2 deletion failed)
 
Integer gevCallSolverHandleCollect
 Collect solution from solver job if called with gevSolveLinkAsyncGrid (0 loaded, 1 unknown job handle, 2 job is running, 3 other error), delete instance
 

Initialization

void gevRegisterWriteCallback
 Register callback for log and status streams
 
void gevCompleteEnvironment
 Complete initialization of environment
 
Integer gevInitEnvironmentLegacy
 Initialization in legacy mode (from control file)
 

Interrupt

void gevTerminateUninstall
 Uninstalls an already registered interrupt handler
 
void gevTerminateInstall
 Installs an already registered interrupt handler
 
void gevTerminateSet
 Register a pointer to some memory that will indicate an interrupt and the pointer to a interrupt handler and installs it
 
Boolean gevTerminateGet
 Check if one should interrupt
 
void gevTerminateClear
 Resets the interrupt counter
 
void gevTerminateRaise
 Increases the interrupt counter
 
void gevTerminateGetHandler
 Get installed termination handler
 

Logging

Boolean gevSwitchLogStat
 Switch log and status streams to another file or callback
 
Boolean gevSwitchLogStatEx
 Switch log and status streams to another file or callback
 
Pointer gevGetLShandle
 Returns handle to last log and status stream stored by gevSwitchLogStat (Workaround for problem with vptr in Python)
 
Boolean gevRestoreLogStat
 Restore log status stream settings
 
Boolean gevRestoreLogStatRewrite
 Restore log status stream settings but never append to former log
 
void gevLog
 Send string to log stream
 
void gevLogPChar
 Send PChar to log stream, no newline added
 
void gevStat
 Send string to status stream
 
void gevStatC
 Send string to status and copy to listing file
 
void gevStatPChar
 Send PChar to status stream, no newline added
 
void gevStatAudit
 GAMS internal status stream operation {=0}
 
void gevStatCon
 GAMS internal status stream operation {=1}
 
void gevStatCoff
 GAMS internal status stream operation {=2}
 
void gevStatEOF
 GAMS internal status stream operation {=3}
 
void gevStatSysout
 GAMS internal status stream operation {=4}
 
void gevStatAddE
 GAMS internal status stream operation {=5}
 
void gevStatAddV
 GAMS internal status stream operation {=6}
 
void gevStatAddJ
 GAMS internal status stream operation {=7}
 
void gevStatEject
 GAMS internal status stream operation {=8}
 
void gevStatEdit
 GAMS internal status stream operation {=9}
 
void gevStatE
 GAMS internal status stream operation {=E}
 
void gevStatV
 GAMS internal status stream operation {=V}
 
void gevStatT
 GAMS internal status stream operation {=T}
 
void gevStatA
 GAMS internal status stream operation {=A}
 
void gevStatB
 GAMS internal status stream operation {=B}
 
void gevLogStat
 Send string to log and status streams and copy to listing file
 
void gevLogStatNoC
 Send string to log and status streams
 
void gevLogStatPChar
 Send string to log and status streams, no newline added
 
void gevLogStatFlush
 Flush status streams (does not work with callback)
 
ShortString gevGetAnchor
 Get anchor line for log (points to file and is clickable in GAMS IDE)
 
void gevLSTAnchor
 Put a line to log that points to the current lst line"
 
Integer gevStatAppend
 Append status file to current status file
 
void gevMIPReport
 Print MIP report to log and lst
 

Other

ShortString gevGetScratchName
 Get scratch file name plus scratch extension including path of scratch directory
 
Integer gevWriteModelInstance
 Creates model instance file
 
Integer gevDuplicateScratchDir
 Duplicates a scratch directory and points to read only files in source scratch directory
 

Timing

Double gevTimeJNow
 GAMS Julian time
 
Double gevTimeDiff
 Time difference in seconds since creation or last call to gevTimeDiff
 
Double gevTimeDiffStart
 Time difference in seconds since creation of object
 
void gevTimeSetStart
 Reset timer (overwrites time stamp from creation)
 

Enumerated Constants

 
gevLogStatMode gevdoErr  = 0
  gevdoStat  = 1
  gevdoLog  = 2
 
gevCallSolverMode gevSolverSameStreams  = 0
  gevSolverQuiet  = 1
  gevSolverOwnFile  = 2
 
gevCallSolverSolveLink gevSolveLinkCallScript  = 1
  gevSolveLinkCallModule  = 2
  gevSolveLinkAsyncGrid  = 3
  gevSolveLinkAsyncSimulate  = 4
  gevSolveLinkLoadLibrary  = 5
 
gevOptions gevPageWidth  = PageWidth
  gevPageSize  = PageSize
  gevsubsysFile  = subsysFile
  gevNameScrDir  = NameScrDir
  gevNameSysDir  = NameSysDir
  gevNameCurDir  = NameCurDir
  gevNameWrkDir  = NameWrkDir
  gevLogOption  = LogOption
  gevNameLogFile  = NameLogFile
  gevNameCtrFile  = NameCtrFile
  gevNameMatrix  = NameMatrix
  gevNameInstr  = NameInstr
  gevNameStaFile  = NameStaFile
  gevlicenseFile  = licenseFile
  gevKeep  = Keep
  gevIDEFlag  = IDEFlag
  gevIterLim  = IterLim
  gevDomLim  = DomLim
  gevResLim  = ResLim
  gevOptCR  = OptCR
  gevOptCA  = OptCA
  gevSysOut  = SysOut
  gevNodeLim  = NodeLim
  gevWorkFactor  = WorkFactor
  gevWorkSpace  = WorkSpace
  gevSavePoint  = SavePoint
  gevHeapLimit  = HeapLimit
  gevNameScrExt  = NameScrExt
  gevInteger1  = Integer1
  gevInteger2  = Integer2
  gevInteger3  = Integer3
  gevInteger4  = Integer4
  gevInteger5  = Integer5
  gevFDDelta  = FDDelta
  gevFDOpt  = FDOpt
  gevAlgFileType  = AlgFileType
  gevGamsVersion  = GamsVersion
  gevGenSolver  = GenSolver
  gevCurSolver  = CurSolver
  gevThreadsRaw  = ThreadsRaw
  gevUseCutOff  = UseCutOff
  gevUseCheat  = UseCheat
  gevNameGamsDate  = NameGamsDate
  gevNameGamsTime  = NameGamsTime
  gevLicense1  = License1
  gevLicense2  = License2
  gevLicense3  = License3
  gevLicense4  = License4
  gevLicense5  = License5
  gevLicense6  = License6
  gevLicense7  = License7
  gevLicense8  = License8
  gevNameParams  = NameParams
  gevNameScenFile  = NameScenFile
  gevNameExtFFile  = NameExtFFile
  gevisDefaultLicense  = isDefaultLicense
  gevisDefaultSubsys  = isDefaultSubsys
  gevCheat  = Cheat
  gevCutOff  = CutOff
  gevReal1  = Real1
  gevReal2  = Real2
  gevReal3  = Real3
  gevReal4  = Real4
  gevReal5  = Real5
  gevReform  = Reform
  gevTryInt  = TryInt

Definitions

gevNSolves 

Number of solves

Type
Property of type Double
Action
read

gevSkipIOLegacySet 

Prevent log and status file to be opened

Type
Property of type Boolean
Action
write

gevThreads 

Number of threads (1..n); if option gevThreadsRaw = 0, this function gives the number of available processors

Type
Property of type Integer
Action
read

gevCallSolver 

Call GAMS solver on GMO model or control file

Type
Function returns Integer
Parameters
   Pointer    gmoptr
     Pointer to GAMS modeling object
  const  ShortString    cntrfn
     Name of control file
  const  ShortString    solvername
     Name of solver
   Integer    solvelink
     Solvelink option for solver called through gevCallSolver (see enumerated constants)
   Integer    Logging
     Log option for solver called through gevCallSolver (see enumerated constants)
  const  ShortString    logfn
     Log file name
  const  ShortString    statfn
     Status file name
   Double    reslim
     Resource limit
   Integer    iterlim
     Iteration limit
   Integer    domlim
     Domain violation limit
   Double    optcr
     Optimality criterion for relative gap
   Double    optca
     Optimality criterion for absolute gap
  var  Pointer    jobhandle
     Handle to solver job in case of solvelink=gevSolveLinkAsyncGrid
  out  ShortString    msg
     Message

gevCallSolverHandleCollect 

Collect solution from solver job if called with gevSolveLinkAsyncGrid (0 loaded, 1 unknown job handle, 2 job is running, 3 other error), delete instance

Type
Function returns Integer
Parameters
  var  Pointer    jobhandle
     Handle to solver job in case of solvelink=gevSolveLinkAsyncGrid
   Pointer    gmoptr
     Pointer to GAMS modeling object

gevCallSolverHandleDelete 

Delete instance of solver job if called with gevSolveLinkAsyncGrid (0 deleted, 1 unknown job handle, 2 deletion failed)

Type
Function returns Integer
Parameters
  var  Pointer    jobhandle
     Handle to solver job in case of solvelink=gevSolveLinkAsyncGrid

gevCallSolverHandleStatus 

Check status of solver job if called with gevSolveLinkAsyncGrid (0 job is done, 1 unknown job handle, 2 job is running)

Type
Function returns Integer
Parameters
   Pointer    jobhandle
     Handle to solver job in case of solvelink=gevSolveLinkAsyncGrid

gevCallSolverNextGridDir 

Creates grid directory for next gevCallSolver call and returns name (if called with gevSolveLinkAsyncGrid or gevSolveLinkAsyncSimulate)

Type
Function returns ShortString

gevCapabilityCheck 

Check if solver is capable to handle model type given

Type
Function returns Integer
Parameters
   Integer    modeltype
     Modeltype
  const  ShortString    solvername
     Name of solver
  var  Boolean    capable
     Flag whether solver is capable or not

gevCompleteEnvironment 

Complete initialization of environment

Type
Procedure
Parameters
   Pointer    palg
     Pointer to ALGX structure (GAMS Internal)
   Pointer    ivec
     Array of integer options
   Pointer    rvec
     Array of real/double options
   Pointer    svec
     Array of string options

gevDuplicateScratchDir 

Duplicates a scratch directory and points to read only files in source scratch directory

Type
Function returns Integer
Parameters
  const  ShortString    scrdir
     Scratch directory
  const  ShortString    logfn
     Log file name
  out  ShortString    cntrfn
     Name of control file

gevEvalJacLegacy 

Legacy Jacobian Evaluation: Evaluate row and store in Jacobian structure

Type
Function returns Integer
Parameters
   Pointer    evalptr
     Pointer to structure for legacy Jacobian evaluation
   Integer    si
     Solve index for row i
   PDoubleArray    x
     Input values for variables
  var  Double    f
     Function value
   PDoubleArray    jac
     Array to store the gradients
  var  Integer    domviol
     Domain violations
  var  Integer    njacsupd
     Number of Jacobian elements updated

gevEvalJacLegacyX 

Legacy Jacobian Evaluation: Evaluate set of rows and store in Jacobian structure

Type
Function returns Integer
Parameters
   Pointer    evalptr
     Pointer to structure for legacy Jacobian evaluation
   Integer    cnt
     count
   PLongIntArray    rowidx
     Vector of row indicies
   PDoubleArray    x
     Input values for variables
   PDoubleArray    fvec
     Vector of function values
   PDoubleArray    jac
     Array to store the gradients
  var  Integer    domviol
     Domain violations
  var  Integer    njacsupd
     Number of Jacobian elements updated

gevEvalNewPointLegacy 

Legacy Jacobian Evaluation: Set new point and do point copy magic

Type
Function returns Integer
Parameters
   Pointer    evalptr
     Pointer to structure for legacy Jacobian evaluation
   PDoubleArray    x
     Input values for variables

gevFreeJacLegacy 

Legacy Jacobian Evaluation: Free row wise Jacobian structure

Type
Procedure
Parameters
  var  Pointer    evalptr
     Pointer to structure for legacy Jacobian evaluation

gevGetALGX 

Pass pointer to ALGX structure

Type
Function returns Pointer

gevGetAnchor 

Get anchor line for log (points to file and is clickable in GAMS IDE)

Type
Function returns ShortString
Parameters
  const  ShortString    s
     String

gevGetCurrentSolver 

Name of the select solver

Type
Function returns ShortString
Parameters
   Pointer    gmoptr
     Pointer to GAMS modeling object

gevGetDblOpt 

Get double valued option (see enumerated constants)

Type
Function returns Double
Parameters
  const  ShortString    optname
     Name of option (see enumerated constants)

gevGetIntOpt 

Get integer valued option (see enumerated constants)

Type
Function returns Integer
Parameters
  const  ShortString    optname
     Name of option (see enumerated constants)

gevGetLShandle 

Returns handle to last log and status stream stored by gevSwitchLogStat (Workaround for problem with vptr in Python)

Type
Function returns Pointer

gevGetScratchName 

Get scratch file name plus scratch extension including path of scratch directory

Type
Function returns ShortString
Parameters
  const  ShortString    s
     String

gevGetSlvExeInfo 

Name of solver executable

Type
Function returns Integer
Parameters
  const  ShortString    solvername
     Name of solver
  out  ShortString    exename
     Name of solver executable

gevGetSlvLibInfo 

Solver library name, prefix, and API version

Type
Function returns Integer
Parameters
  const  ShortString    solvername
     Name of solver
  out  ShortString    libname
     Name of solver library
  out  ShortString    prefix
     Prefix of solver
  out  Integer    ifversion
     Version of solver interface

gevGetSolver 

Name of the solver chosen for modeltype (if non is chosen, it is the default)

Type
Function returns ShortString
Parameters
   Integer    modeltype
     Modeltype

gevGetSolverDefault 

Name of the default solver for modeltype

Type
Function returns ShortString
Parameters
   Integer    modeltype
     Modeltype

gevGetStrOpt 

Get string valued option (see enumerated constants)

Type
Function returns ShortString
Parameters
  const  ShortString    optname
     Name of option (see enumerated constants)

gevId2Solver 

Solver name

Type
Function returns ShortString
Parameters
   Integer    solverid
     Internal ID of solver

gevInitEnvironmentLegacy 

Initialization in legacy mode (from control file)

Type
Function returns Integer
Parameters
  const  ShortString    cntrfn
     Name of control file

gevInitJacLegacy 

Legacy Jacobian Evaluation: Initialize row wise Jacobian structure

Type
Function returns Integer
Parameters
  var  Pointer    evalptr
     Pointer to structure for legacy Jacobian evaluation
   Pointer    gmoptr
     Pointer to GAMS modeling object

gevLog 

Send string to log stream

Type
Procedure
Parameters
  const  ShortString    s
     String

gevLogPChar 

Send PChar to log stream, no newline added

Type
Procedure
Parameters
  const  PAnsiChar    p
     Pointer to array of characters

gevLogStat 

Send string to log and status streams and copy to listing file

Type
Procedure
Parameters
  const  ShortString    s
     String

gevLogStatFlush 

Flush status streams (does not work with callback)

Type
Procedure

gevLogStatNoC 

Send string to log and status streams

Type
Procedure
Parameters
  const  ShortString    s
     String

gevLogStatPChar 

Send string to log and status streams, no newline added

Type
Procedure
Parameters
  const  PAnsiChar    p
     Pointer to array of characters

gevLSTAnchor 

Put a line to log that points to the current lst line"

Type
Procedure
Parameters
  const  ShortString    s
     String

gevMIPReport 

Print MIP report to log and lst

Type
Procedure
Parameters
   Pointer    gmoptr
     Pointer to GAMS modeling object
   Double    fixobj
   Integer    fixiter
   Double    agap
   Double    rgap

gevNextNLLegacy 

Legacy Jacobian Evaluation: Provide next nonlinear row, start with M

Type
Function returns Integer
Parameters
   Pointer    evalptr
     Pointer to structure for legacy Jacobian evaluation
   Integer    si
     Solve index for row i

gevNumSolvers 

Number of solvers in the system

Type
Function returns Integer

gevRegisterWriteCallback 

Register callback for log and status streams

Type
Procedure
Parameters
  Tgevlswrite    lsw
    Procedure (const msg : ShortString, mode : Integer, usrmem : Pointer )
     Pointer to callback for log and status streams
  const  Boolean    logenabled
     Flag to enable log or not
   Pointer    usrmem
     User memory

gevRestoreLogStat 

Restore log status stream settings

Type
Function returns Boolean
Parameters
  var  Pointer    lshandle
     Log and status handle for later restoring

gevRestoreLogStatRewrite 

Restore log status stream settings but never append to former log

Type
Function returns Boolean
Parameters
  var  Pointer    lshandle
     Log and status handle for later restoring

gevRowGms2SlvLegacy 

Legacy Jacobian Evaluation: Provide permuted row index

Type
Function returns Integer
Parameters
   Pointer    evalptr
     Pointer to structure for legacy Jacobian evaluation
   Integer    si
     Solve index for row i

gevSetColRowPermLegacy 

Legacy Jacobian Evaluation: Set column and row permutation GAMS to solver

Type
Procedure
Parameters
   Pointer    evalptr
     Pointer to structure for legacy Jacobian evaluation
   Integer    n
     Number of variables
   PLongIntArray    cgms2slv
     GAMS to solver permutation of columns
   Integer    m
     Number of constraints
   PLongIntArray    rgms2slv
     GAMS to solver permutation of rows

gevSetDblOpt 

Set double valued option (see enumerated constants)

Type
Procedure
Parameters
  const  ShortString    optname
     Name of option (see enumerated constants)
   Double    rval
     Real/Double value

gevSetIntOpt 

Set integer valued option (see enumerated constants)

Type
Procedure
Parameters
  const  ShortString    optname
     Name of option (see enumerated constants)
   Integer    ival
     Integer value

gevSetJacPermLegacy 

Legacy Jacobian Evaluation: Set Jacobian permutation GAMS to solver

Type
Procedure
Parameters
   Pointer    evalptr
     Pointer to structure for legacy Jacobian evaluation
   Integer    njacs
     Number of Jacobian elements in jacs and jgms2slv arrays
   PLongIntArray    jacs
     Array of original indices of Jacobian elements (1-based), length njacs
   PLongIntArray    jgms2slv
     GAMS to solver permutation of Jacobian elements, length njacs

gevSetStrOpt 

Set string valued option (see enumerated constants)

Type
Procedure
Parameters
  const  ShortString    optname
     Name of option (see enumerated constants)
  const  ShortString    sval
     String value

gevSolver2Id 

Internal ID of solver, 0 for failure

Type
Function returns Integer
Parameters
  const  ShortString    solvername
     Name of solver

gevSolverVisibility 

Provide information if solver is hidden

Type
Function returns Integer
Parameters
  const  ShortString    solvername
     Name of solver
  var  Boolean    hidden
  var  Boolean    defaultok

gevStat 

Send string to status stream

Type
Procedure
Parameters
  const  ShortString    s
     String

gevStatA 

GAMS internal status stream operation {=A}

Type
Procedure
Parameters
  const  ShortString    s
     String

gevStatAddE 

GAMS internal status stream operation {=5}

Type
Procedure
Parameters
   Integer    mi
     Index or constraint
  const  ShortString    s
     String

gevStatAddJ 

GAMS internal status stream operation {=7}

Type
Procedure
Parameters
   Integer    mi
     Index or constraint
   Integer    mj
     Index or variable
  const  ShortString    s
     String

gevStatAddV 

GAMS internal status stream operation {=6}

Type
Procedure
Parameters
   Integer    mj
     Index or variable
  const  ShortString    s
     String

gevStatAppend 

Append status file to current status file

Type
Function returns Integer
Parameters
  const  ShortString    statfn
     Status file name
  out  ShortString    msg
     Message

gevStatAudit 

GAMS internal status stream operation {=0}

Type
Procedure
Parameters
  const  ShortString    s
     String

gevStatB 

GAMS internal status stream operation {=B}

Type
Procedure
Parameters
  const  ShortString    s
     String

gevStatC 

Send string to status and copy to listing file

Type
Procedure
Parameters
  const  ShortString    s
     String

gevStatCoff 

GAMS internal status stream operation {=2}

Type
Procedure

gevStatCon 

GAMS internal status stream operation {=1}

Type
Procedure

gevStatE 

GAMS internal status stream operation {=E}

Type
Procedure
Parameters
  const  ShortString    s
     String
   Integer    mi
     Index or constraint
  const  ShortString    s2
     String

gevStatEdit 

GAMS internal status stream operation {=9}

Type
Procedure
Parameters
   AnsiChar    c
     Character

gevStatEject 

GAMS internal status stream operation {=8}

Type
Procedure

gevStatEOF 

GAMS internal status stream operation {=3}

Type
Procedure

gevStatPChar 

Send PChar to status stream, no newline added

Type
Procedure
Parameters
  const  PAnsiChar    p
     Pointer to array of characters

gevStatSysout 

GAMS internal status stream operation {=4}

Type
Procedure

gevStatT 

GAMS internal status stream operation {=T}

Type
Procedure

gevStatV 

GAMS internal status stream operation {=V}

Type
Procedure
Parameters
  const  ShortString    s
     String
   Integer    mj
     Index or variable
  const  ShortString    s2
     String

gevSwitchLogStat 

Switch log and status streams to another file or callback

Type
Function returns Boolean
Parameters
   Integer    lo
     logoption (0..3)
  const  ShortString    logfn
     Log file name
  const  Boolean    logappend
     Flag whether to append to log stream or not
  const  ShortString    statfn
     Status file name
  const  Boolean    statappend
     Flag whether to append to status stream or not
  Tgevlswrite    lsw
    Procedure (const msg : ShortString, mode : Integer, usrmem : Pointer )
     Pointer to callback for log and status streams
   Pointer    usrmem
     User memory
  var  Pointer    lshandle
     Log and status handle for later restoring

gevSwitchLogStatEx 

Switch log and status streams to another file or callback

Type
Function returns Boolean
Parameters
   Integer    lo
     logoption (0..3)
  const  ShortString    logfn
     Log file name
  const  Boolean    logappend
     Flag whether to append to log stream or not
  const  ShortString    statfn
     Status file name
  const  Boolean    statappend
     Flag whether to append to status stream or not
  Tgevlswrite    lsw
    Procedure (const msg : ShortString, mode : Integer, usrmem : Pointer )
     Pointer to callback for log and status streams
   Pointer    usrmem
     User memory
  var  Pointer    lshandle
     Log and status handle for later restoring
  const  Boolean    doStack
     Select stacking mode, where a new callback is stacked over the current settings instead of undoing them

gevSynchronizeOpt 

Copy environment options to passed in option object

Type
Procedure
Parameters
   Pointer    optptr
     Pointer to option object

gevTerminateClear 

Resets the interrupt counter

Type
Procedure

gevTerminateGet 

Check if one should interrupt

Type
Function returns Boolean

gevTerminateGetHandler 

Get installed termination handler

Type
Procedure
Parameters
  var  Pointer    intr
     Pointer to some memory indicating an interrupt
  var  Pointer    ehdler
     Pointer to interrupt handler

gevTerminateInstall 

Installs an already registered interrupt handler

Type
Procedure

gevTerminateRaise 

Increases the interrupt counter

Type
Procedure

gevTerminateSet 

Register a pointer to some memory that will indicate an interrupt and the pointer to a interrupt handler and installs it

Type
Procedure
Parameters
   Pointer    intr
     Pointer to some memory indicating an interrupt
   Pointer    ehdler
     Pointer to interrupt handler

gevTerminateUninstall 

Uninstalls an already registered interrupt handler

Type
Procedure

gevTimeDiff 

Time difference in seconds since creation or last call to gevTimeDiff

Type
Function returns Double

gevTimeDiffStart 

Time difference in seconds since creation of object

Type
Function returns Double

gevTimeJNow 

GAMS Julian time

Type
Function returns Double

gevTimeSetStart 

Reset timer (overwrites time stamp from creation)

Type
Procedure

gevWriteModelInstance 

Creates model instance file

Type
Function returns Integer
Parameters
  const  ShortString    mifn
     Model instance file name
   Pointer    gmoptr
     Pointer to GAMS modeling object
  var  Integer    nlcodelen
     Length of nonlinear code