ConfiEnvironment (CFG) API Documentation
Generated for GAMS 34.3.0
Functions, Procedures and Properties
Initialization
- cfgReadConfig
- Read GAMS configuration file
- cfgReadConfigGUC
- Read GAMS configuration file plus gamsconfig.yaml
GAMS Solvers
- cfgNumAlgs
- Number of solvers
- cfgDefaultAlg
- Number of default solver for model type proc
- cfgAlgName
- Name of solver
- cfgAlgCode
- Code of solver
- cfgAlgHidden
- Returns true, if alg should be hidden
- cfgAlgAllowsModifyProblem
- Solver can modify problem
- cfgAlgLibInfo
- Get link library info for solver
- cfgAlgThreadSafeIndic
- Get thread safety indicator for solver
- cfgAlgNumber
- Number of solver
- cfgAlgCapability
- Solver Modeltype capability matrix
- cfgAlgCreate
- Create solver link object
- cfgAlgReadyAPI
- Call solver readyapi
- cfgAlgModifyProblem
- Call solver modifyproblem
- cfgAlgCallSolver
- Call solver modifyproblem
- cfgAlgFree
- Call solver modifyproblem
- cfgDefFileName
- Gives name of definition file for given solver (Returns true on success, false in case of problem)
Other
- cfgModelTypeName
- Modeltype name
- cfgModelTypeNumber
- Modeltype number
- cfgNumMsg
- Number of pending messages
- cfgGetMsg
- Pending messages
Arguments
- alg
- Solver number
- defFileName
- Name of definition file
- filename
- Configuration file name
- id
- Solver name
- proc
- Model type number
- sysDir
- GAMS System Directory
Calling Sequences
cfgAlgAllowsModifyProblem
- Solver can modify problem
- Function returns Boolean
- Arguments:
- alg : Integer
- Solver number
cfgAlgCallSolver
- Call solver modifyproblem
- Function returns Integer
- Arguments:
- alg : Integer
- Solver number
- psl : Pointer
- gmo : Pointer
cfgAlgCapability
- Solver Modeltype capability matrix
- Function returns Boolean
- Arguments:
- alg : Integer
- Solver number
- proc : Integer
- Model type number
cfgAlgCode
- Code of solver
- Function returns ShortString
- Arguments:
- alg : Integer
- Solver number
cfgAlgCreate
- Create solver link object
- Function returns Boolean
- Arguments:
- alg : Integer
- Solver number
- var psl : Pointer
- const sysDir : ShortString
- GAMS System Directory
- out msg : ShortString
cfgAlgFree
- Call solver modifyproblem
- Procedure
- Arguments:
- alg : Integer
- Solver number
- var vpsl : Pointer
cfgAlgHidden
- Returns true, if alg should be hidden
- Function returns Boolean
- Arguments:
- alg : Integer
- Solver number
cfgAlgLibInfo
- Get link library info for solver
- Function returns Integer
- Arguments:
- alg : Integer
- Solver number
- out name : ShortString
- out prefix : ShortString
cfgAlgModifyProblem
- Call solver modifyproblem
- Function returns Integer
- Arguments:
- alg : Integer
- Solver number
- psl : Pointer
cfgAlgName
- Name of solver
- Function returns ShortString
- Arguments:
- alg : Integer
- Solver number
cfgAlgNumber
- Number of solver
- Function returns Integer
- Arguments:
- const id : ShortString
- Solver name
cfgAlgReadyAPI
- Call solver readyapi
- Function returns Integer
- Arguments:
- alg : Integer
- Solver number
- psl : Pointer
- gmo : Pointer
- opt : Pointer
cfgAlgThreadSafeIndic
- Get thread safety indicator for solver
- Function returns Integer
- Arguments:
- alg : Integer
- Solver number
cfgDefaultAlg
- Number of default solver for model type proc
- Function returns Integer
- Arguments:
- proc : Integer
- Model type number
cfgDefFileName
- Gives name of definition file for given solver (Returns true on success, false in case of problem)
- Function returns Boolean
- Arguments:
- const id : ShortString
- Solver name
- out defFileName: ShortString
- Name of definition file
cfgGetMsg
- Pending messages
- Function returns ShortString
cfgModelTypeName
- Modeltype name
- Function returns ShortString
- Arguments:
- proc : Integer
- Model type number
cfgModelTypeNumber
- Modeltype number
- Function returns Integer
- Arguments:
- const id : ShortString
- Solver name
cfgNumAlgs
- Number of solvers
- Function returns Integer
cfgNumMsg
- Number of pending messages
- Function returns Integer
cfgReadConfig
- Read GAMS configuration file
- Function returns Integer
- Arguments:
- const filename : ShortString
- Configuration file name
cfgReadConfigGUC
- Read GAMS configuration file plus gamsconfig.yaml
- Function returns Integer
- Arguments:
- const filename : ShortString
- Configuration file name
- const sysDir : ShortString
- GAMS System Directory
Enumerated Constants
- cfgProcType
- cfgProc_none = 0
- cfgProc_lp = 1
- cfgProc_mip = 2
- cfgProc_rmip = 3
- cfgProc_nlp = 4
- cfgProc_mcp = 5
- cfgProc_mpec = 6
- cfgProc_rmpec = 7
- cfgProc_cns = 8
- cfgProc_dnlp = 9
- cfgProc_rminlp = 10
- cfgProc_minlp = 11
- cfgProc_qcp = 12
- cfgProc_miqcp = 13
- cfgProc_rmiqcp = 14
- cfgProc_emp = 15
- cfgProc_nrofmodeltypes = 16
Undocumented Arguments
- gmo
- msg
- name
- opt
- prefix
- psl
- result
- vpsl