IBM ILOG OPL JavaScript Reference: Class IloOplSettings

Class IloOplSettings

IloOplSettings

Description:

Accesses OPL settings.

Relative file paths are resolved relatively to the path of the current model file.

See the Overview for a general presentation of the ILOG Script extensions for OPL.

Iterating properties:: Iterates on names of OPL settings with values that are different from their default.

Index resolution:: Default behavior.

Available for:: all

See also:: IloOplModel#settings

Property Summary
Field Attributes	Field Name and Description
all	bigMapThreshold Some activities on arrays are reduced on big instances to save memory and time.
all	datachecks Tells OPL to check, or not, the data integrity coming from databases or flat files.
all	dbExecuteFailOnError Raises runtime errors if a `DBExecute` statement fails.
all	displayComponentName Displays tuple component values with their names.
all	displayIndex Displays array items with their index value.
all	displayOnePerLine Displays one collection item per line.
all	displayPrecision Sets the display precision, that is, the number of fractional digits to display for float numbers.
all	displayWidth Sets the display width.
all	dvarNames The names of decision variables at runtime.
all	exportExternalData Name of the file to which OPL will export the external data.
all	exportInternalData Name of the file to which OPL will export the internal data.
all	forceUsage Forces the use of model elements.
all	GC Tells OPL to enable/disable the JavaScript garbage collector.
all	locations Maintains the information on file location for runtime objects.
all	mainEndEnabled Enables execution of `end` methods from flow control scripting.
all	mainNewEngineEnv Changes the way submodels are allocated.
all	names Generates names for runtime objects.
all	relaxationLevel Changes the way automatic relaxation of infeasible models is done.
all	skipAssert Skips execution of all `assert` statements.
all	slicingCache Tells OPL to index the data for filtering or not.
all	warnings Enables warnings.

Property Detail

bigMapThreshold

{int} bigMapThreshold

Some activities on arrays are reduced on big instances to save memory and time. These activities include naming and display. Default: 100

Available for:: all

datachecks

{boolean} datachecks

Tells OPL to check, or not, the data integrity coming from databases or flat files. If you are sure of non duplicated items in the sets you are reading you can use this setting to go faster. Default: true

Available for:: all

dbExecuteFailOnError

{boolean} dbExecuteFailOnError

Raises runtime errors if a DBExecute statement fails. Otherwise, a warning is displayed. Default: false

Available for:: all

displayIndex

{boolean} displayIndex

Displays array items with their index value. Default: false

Available for:: all

displayOnePerLine

{boolean} displayOnePerLine

Displays one collection item per line. Default: false

Available for:: all

displayPrecision

{int} displayPrecision

Sets the display precision, that is, the number of fractional digits to display for float numbers. Default: 4

Available for:: all

displayWidth

{int} displayWidth

Sets the display width. Breaks the lines that have more characters. Default: 75

Available for:: all

dvarNames

{boolean} dvarNames

The names of decision variables at runtime. Useful for debugging. Default: false

Available for:: all

exportExternalData

{string} exportExternalData

Name of the file to which OPL will export the external data. Default: null

Available for:: all

exportInternalData

{string} exportInternalData

Name of the file to which OPL will export the internal data. Default: null

Available for:: all

forceUsage

{boolean} forceUsage

Forces the use of model elements. Instantiates all the model elements declared. Default: false

Available for:: all

{boolean} GC

Tells OPL to enable/disable the JavaScript garbage collector. Default: true

Available for:: all

locations

{boolean} locations

Maintains the information on file location for runtime objects. Useful for debugging. Default: false

Available for:: all

mainEndEnabled

{boolean} mainEndEnabled

Enables execution of end methods from flow control scripting. Default: true

Available for:: all

mainNewEngineEnv

{int} mainNewEngineEnv

Changes the way submodels are allocated. Default: 1 Value 1 means that a new instance of IloOplModel with a new algorithm is allocated separately from the main model. Value 0 means that all models are allocated to the same stack. Use the value 0 when multi-model applications get non expected results.

Available for:: all

names

{boolean} names

Generates names for runtime objects. Useful for debugging. Default: false

Available for:: all

relaxationLevel

{int} relaxationLevel

Changes the way automatic relaxation of infeasible models is done. Default: 0
Value 0 means that all variables and labelled constraints can be relaxed. Value 1 means that only labelled constraints can be relaxed.

Available for:: all

skipAssert

{boolean} skipAssert

Skips execution of all assert statements. Useful for debugging. Default: false

Available for:: all

slicingCache

{boolean} slicingCache

Tells OPL to index the data for filtering or not. Default: true

Available for:: all

warnings

{boolean} warnings

Enables warnings. Default: true

Available for:: all