GAMSGlobals defines constants that are used by com.gams.api package. More...

Classes
enum	ArchType
	GAMS enumerated type of architecture. More...

enum	AttributeValue
	Atttribute Values as enumerated integer. More...

enum	DataType
	GAMS Data Types. More...

enum	DebugLevel
	Define GAMS Debug Level of different values and string representations. More...

enum	EquType
	Equation SubType. More...

enum	ExitCodeMessage
	The possible return codes of the GAMS compiler and execution system (cmexRC). More...

enum	ModelStat
	Model Solution Status. More...

enum	OSType
	GAMS enumerated type of operating system. More...

enum	SetType
	Set SubType. More...

enum	SolveStat
	Solver termination condition. More...

enum	SpecialValues
	Special GAMS Values used by GAMS Java API. More...

enum	SpecialValues_int
	Special GAMS Value as enumerated integer. More...

enum	UpdateAction
	What field to update. More...

enum	VarType
	Variable SubType. More...

Static Public Member Functions
static OSType	getOSType ()
	Get the enumerated type of operating system. More...

static ArchType	getArchType ()
	Get the enumerated type of architecture. More...

static void	setScratchFilePrefix (String str)
	Set a file prefix name. More...

static void	setWorkingDirectory (String str)
	Set a file prefix name. More...

static void	setWorkingDirectoryPrefix (String str)
	Set a working directory prefix name. More...

Static Public Attributes
static final int	MAXDIM = 20
	Maximum dimension allowed, currently 20. More...

static final int	STR_LEN = 256
	Maximum length of String allowed, currently 256. More...

static final int	MAX_NO_IDIR = 40
	Maximum input directories allowed, currently 40. More...

static final String	EMPTY_STRING = new String()
	Immutable Java object represented an empty String. More...

static final String	GAMS_CALLSTR = "gams"
	GAMS Call string ("gams") More...

static final String	CHECKPOINT_FILE_EXTENSION = ".g00"
	GAMS Checkpoint file extension (".g00") More...

static final String	GAMS_FILE_EXTENSION = ".gms"
	GAMS file extension (".gms") More...

static final String	GDX_FILE_EXTENSION = ".gdx"
	GDX file extension (".gdx") More...

static final String	LOG_FILE_EXTENSION = ".log"
	GAMS default log file extension (".log") More...

static final String	OPT_FILE_EXTENSION = ".opt"
	OPT file extension (".opt") More...

static final String	OUTPUT_FILE_EXTENSION = ".lst"
	GAMS default listing file extension (".lst") More...

static final String	PARAMETER_FILE_EXTENSION = ".pf"
	GAMS parameter file extension (".pf") More...

static final String	JOB_NAME_PREFIX = "gjo"
	Prefix file name for a GAMSJob ("gjo") More...

static final String	DB_NAME_PREFIX = "gdb"
	Prefix file name for a GAMSDatabase ("gdb") More...

static final String	CP_NAME_PREFIX = "gcp"
	Prefix file name for a GAMSCheckpoint ("gcp") More...

static final String	MI_NAME_PREFIX = "gmi"
	Prefix file name for a GAMSModelInstance ("gmi") More...

static final String	WINDOW_EXEC_EXTENSION = ".exe"
	Default windows execution file extension (".exe") More...

static final String	FILE_SEPARATOR = System.getProperty("file.separator")
	Platform dependent file separator ("\" on windows and "/" on UNIX) More...

static final String	PATH_SEPARATOR = System.getProperty("path.separator")
	Platform dependent path separator (";" on windows and ":" on UNIX) More...

static final String	LINE_SEPARATOR = System.getProperty("line.separator")
	Platform dependent line separator (e.g. More...

static final String	OS_NAME = System.getProperty("os.name").toLowerCase()
	Operating system name. More...

static String	scratchFilePrefix = "_gams_java_"
	A (modifiable) file prefix used for automatically generating files. More...

static String	workingDirectory = System.getProperty("java.io.tmpdir")
	A (modifiable) working directory, default value: java io's temporary directory, System.getProperty("java.io.tmpdir"). More...

static String	workingDirectoryPrefix = "gams_"
	A (modifiable) directory prefix used for creating temporary directory. More...

Detailed Description

GAMSGlobals defines constants that are used by com.gams.api package.

These constants include equation subtype, variable subtype, solver termination conditions, model solution status, and update action.

Member Function Documentation

◆ getArchType()

static ArchType com.gams.api.GAMSGlobals.getArchType ( )

static

Get the enumerated type of architecture.

See also: GAMSGlobals.ArchType

◆ getOSType()

static OSType com.gams.api.GAMSGlobals.getOSType ( )

static

Get the enumerated type of operating system.

See also: GAMSGlobals.OSType

◆ setScratchFilePrefix()

static void com.gams.api.GAMSGlobals.setScratchFilePrefix ( String str )

static

Set a file prefix name.

◆ setWorkingDirectory()

static void com.gams.api.GAMSGlobals.setWorkingDirectory ( String str )

static

Set a file prefix name.

◆ setWorkingDirectoryPrefix()

static void com.gams.api.GAMSGlobals.setWorkingDirectoryPrefix ( String str )

static

Set a working directory prefix name.

Member Data Documentation

◆ CHECKPOINT_FILE_EXTENSION

final String com.gams.api.GAMSGlobals.CHECKPOINT_FILE_EXTENSION = ".g00"

static

GAMS Checkpoint file extension (".g00")

◆ CP_NAME_PREFIX

final String com.gams.api.GAMSGlobals.CP_NAME_PREFIX = "gcp"

static

Prefix file name for a GAMSCheckpoint ("gcp")

◆ DB_NAME_PREFIX

final String com.gams.api.GAMSGlobals.DB_NAME_PREFIX = "gdb"

static

Prefix file name for a GAMSDatabase ("gdb")

◆ EMPTY_STRING

final String com.gams.api.GAMSGlobals.EMPTY_STRING = new String()

static

Immutable Java object represented an empty String.

◆ FILE_SEPARATOR

final String com.gams.api.GAMSGlobals.FILE_SEPARATOR = System.getProperty("file.separator")

static

Platform dependent file separator ("\" on windows and "/" on UNIX)

◆ GAMS_CALLSTR

final String com.gams.api.GAMSGlobals.GAMS_CALLSTR = "gams"

static

GAMS Call string ("gams")

◆ GAMS_FILE_EXTENSION

final String com.gams.api.GAMSGlobals.GAMS_FILE_EXTENSION = ".gms"

static

GAMS file extension (".gms")

◆ GDX_FILE_EXTENSION

final String com.gams.api.GAMSGlobals.GDX_FILE_EXTENSION = ".gdx"

static

GDX file extension (".gdx")

◆ JOB_NAME_PREFIX

final String com.gams.api.GAMSGlobals.JOB_NAME_PREFIX = "gjo"

static

Prefix file name for a GAMSJob ("gjo")

◆ LINE_SEPARATOR

final String com.gams.api.GAMSGlobals.LINE_SEPARATOR = System.getProperty("line.separator")

static

Platform dependent line separator (e.g.

"\n" on UNIX)

◆ LOG_FILE_EXTENSION

final String com.gams.api.GAMSGlobals.LOG_FILE_EXTENSION = ".log"

static

GAMS default log file extension (".log")

◆ MAX_NO_IDIR

final int com.gams.api.GAMSGlobals.MAX_NO_IDIR = 40

static

Maximum input directories allowed, currently 40.

◆ MAXDIM

final int com.gams.api.GAMSGlobals.MAXDIM = 20

static

Maximum dimension allowed, currently 20.

◆ MI_NAME_PREFIX

final String com.gams.api.GAMSGlobals.MI_NAME_PREFIX = "gmi"

static

Prefix file name for a GAMSModelInstance ("gmi")

◆ OPT_FILE_EXTENSION

final String com.gams.api.GAMSGlobals.OPT_FILE_EXTENSION = ".opt"

static

OPT file extension (".opt")

◆ OS_NAME

final String com.gams.api.GAMSGlobals.OS_NAME = System.getProperty("os.name").toLowerCase()

static

Operating system name.

◆ OUTPUT_FILE_EXTENSION

final String com.gams.api.GAMSGlobals.OUTPUT_FILE_EXTENSION = ".lst"

static

GAMS default listing file extension (".lst")

◆ PARAMETER_FILE_EXTENSION

final String com.gams.api.GAMSGlobals.PARAMETER_FILE_EXTENSION = ".pf"

static

GAMS parameter file extension (".pf")

◆ PATH_SEPARATOR

final String com.gams.api.GAMSGlobals.PATH_SEPARATOR = System.getProperty("path.separator")

static

Platform dependent path separator (";" on windows and ":" on UNIX)

◆ scratchFilePrefix

String com.gams.api.GAMSGlobals.scratchFilePrefix = "_gams_java_"

static

A (modifiable) file prefix used for automatically generating files.

◆ STR_LEN

final int com.gams.api.GAMSGlobals.STR_LEN = 256

static

Maximum length of String allowed, currently 256.

◆ WINDOW_EXEC_EXTENSION

final String com.gams.api.GAMSGlobals.WINDOW_EXEC_EXTENSION = ".exe"

static

Default windows execution file extension (".exe")

◆ workingDirectory

String com.gams.api.GAMSGlobals.workingDirectory = System.getProperty("java.io.tmpdir")

static

A (modifiable) working directory, default value: java io's temporary directory, System.getProperty("java.io.tmpdir").

It will be used as parent directory of GAMSWorkspace's working directory in case the working directory is not specified by user.

See also: GAMSWorkspace; GAMSWorkspaceInfo

◆ workingDirectoryPrefix

String com.gams.api.GAMSGlobals.workingDirectoryPrefix = "gams_"

static

A (modifiable) directory prefix used for creating temporary directory.

Classes

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getArchType()

◆ getOSType()

◆ setScratchFilePrefix()

◆ setWorkingDirectory()

◆ setWorkingDirectoryPrefix()

Member Data Documentation

◆ CHECKPOINT_FILE_EXTENSION

◆ CP_NAME_PREFIX

◆ DB_NAME_PREFIX

◆ EMPTY_STRING

◆ FILE_SEPARATOR

◆ GAMS_CALLSTR

◆ GAMS_FILE_EXTENSION

◆ GDX_FILE_EXTENSION

◆ JOB_NAME_PREFIX

◆ LINE_SEPARATOR

◆ LOG_FILE_EXTENSION

◆ MAX_NO_IDIR

◆ MAXDIM

◆ MI_NAME_PREFIX

◆ OPT_FILE_EXTENSION

◆ OS_NAME

◆ OUTPUT_FILE_EXTENSION

◆ PARAMETER_FILE_EXTENSION

◆ PATH_SEPARATOR

◆ scratchFilePrefix

◆ STR_LEN

◆ WINDOW_EXEC_EXTENSION

◆ workingDirectory

◆ workingDirectoryPrefix