ilog.opl

Class IloOplFactory

java.lang.Object

ilog.opl.IloOplFactory

public class IloOplFactory
extends java.lang.Object

The OPL factory allows you to create instances of OPL objects like models, datasources, etc. It initializes the OPL environment. The method end() allows you to clean the memory used by all objects allocated by this factory. Be sure to use it when OPL is no longer used.
You can also manage memory more finely by calling end() on individual objects earlier, as soon as you don't need them.

Constructor Summary

Constructors

Constructor and Description
IloOplFactory() Initialize the OPL environment necessary to create other objects.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToKeepRefs(java.lang.Object obj)
IloCP	createCP() Creates a new ILOG CP Optimizer instance.
IloCplex	createCplex() Creates a new ILOG CPLEX instance.
IloOplCompiler	createOplCompiler()
IloOplConflictIterator	createOplConflictIterator(IloOplModel model)
IloOplCplexBasis	createOplCplexBasis()
IloOplCplexVectors	createOplCplexVectors()
IloOplDataElements	createOplDataElements()
IloOplDataSerializer	createOplDataSerializer(IloOplSettings settings, java.io.OutputStream outs)
IloOplDataSerializer	createOplDataSerializer(java.io.OutputStream outs) Deprecated.
IloOplDataSource	createOplDataSource(java.lang.String filename)
IloOplDataSource	createOplDataSourceFromStream(java.io.InputStream dataStream, java.lang.String name) Creates an OPL data source from a set of data given as a stream.
IloOplDataSource	createOplDataSourceFromString(java.lang.String dataText, java.lang.String name) Creates an OPL data source from a set of data given as a string.
IloOplErrorHandler	createOplErrorHandler() Creates an error handler that display messages on the standard output.
IloOplErrorHandler	createOplErrorHandler(java.io.OutputStream outs)
IloOplModel	createOplModel(IloOplModelDefinition definition, IloCP cp)
IloOplModel	createOplModel(IloOplModelDefinition definition, IloCplex cplex)
IloOplModelDefinition	createOplModelDefinition(IloOplModelSource source, IloOplErrorHandler handler) Deprecated.
IloOplModelDefinition	createOplModelDefinition(IloOplModelSource source, IloOplSettings settings)
IloOplModelSource	createOplModelSource(java.lang.String filename)
IloOplModelSource	createOplModelSource(java.lang.String filename, boolean compiled) Deprecated.
IloOplModelSource	createOplModelSourceFromStream(java.io.InputStream modelStream, java.lang.String modelName) Creates an OPL model source from a model given as a stream.
IloOplModelSource	createOplModelSourceFromString(java.lang.String modelText, java.lang.String modelName) Creates an OPL model source from a model given as a string.
IloOplModelSource	createOplModelSourceFromString(java.lang.String modelText, java.lang.String modelName, boolean compiled) Deprecated.
IloOplProfiler	createOplProfiler()
IloOplProject	createOplProject(java.io.InputStream input, java.lang.String name)
IloOplProject	createOplProject(java.lang.String projectPath)
IloOplRelaxationIterator	createOplRelaxationIterator(IloOplModel model)
IloOplRunConfiguration	createOplRunConfiguration(IloOplModelDefinition def)
IloOplRunConfiguration	createOplRunConfiguration(IloOplModelDefinition def, IloOplDataElements dataElements)
IloOplRunConfiguration	createOplRunConfiguration(java.lang.String modPath)
IloOplRunConfiguration	createOplRunConfiguration(java.lang.String modPath, java.lang.String datPath)
IloOplRunConfiguration	createOplRunConfiguration(java.lang.String modPath, java.lang.String[] datPaths)
IloOplSettings	createOplSettings(IloOplErrorHandler handler)
void	end() Deletes the OPL environment, clearing all the memory used by the objects created through this factory.
JavaToCppOutputStreamAdapter	getErrStream()
static IloOplFactory	getOplFactoryFrom(IloOplModel oplModel) Gets an OPL factory from an existing OPL model.
JavaToCppOutputStreamAdapter	getOutStream()
static java.lang.String	getVersion() Returns the version of the OPL library.
JavaToCppOutputStreamAdapter	getWarningStream()
IloOplDataSerializer	IloOplDataSerializer(IloOplSettings settings, java.io.OutputStream outs, boolean header)
IloIntRange	intRange(int lb, int ub) Creates an integer range.
ilog.concert.IloIntSet	intSet() Creates a set of integer values.
IloMapIndexArray	mapIndexArray(int initialSize) Returns an array to manipulate indices to access instances of IloTupleMap.
ilog.concert.IloNumSet	numSet() Creates a set of numerical values.
static void	registerLicense(java.lang.String license, int signature) Entry point for runtime licenses.
static void	releaseLicense() Forces OPL to release the license it is currently holding.
void	removeFromKeepRefs(java.lang.Object obj)
static void	setDebugMode(boolean debug) Sets debug mode on/off.
static void	setDebugModeWarning(boolean warning) Sets the debug-mode warning message on/off.
void	setError(java.io.OutputStream errorStream) Redirects all error messages to the given stream
void	setOut(java.io.OutputStream outputStream) Redirects all output messages to the given stream
void	setWarning(java.io.OutputStream warningStream) Redirects all warning messages to the given stream
IloSymbolSet	symbolSet() Creates a set of strings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IloOplFactory

public IloOplFactory()

Initialize the OPL environment necessary to create other objects.

Method Detail

getOutStream

public JavaToCppOutputStreamAdapter getOutStream()

getErrStream

public JavaToCppOutputStreamAdapter getErrStream()

getWarningStream

public JavaToCppOutputStreamAdapter getWarningStream()

getOplFactoryFrom

public static IloOplFactory getOplFactoryFrom(IloOplModel oplModel)

Gets an OPL factory from an existing OPL model. This allows you to obtain a factory (suitable to create other objects) from a model, whether it was created itself by an IloOplFactory or by Java code (case if you obtain it from Java, while calling external Java code from script).

setDebugMode

public static void setDebugMode(boolean debug)

Sets debug mode on/off. When debug mode is on, additional checks are carried out in methods, resulting in exceptions thrown to help you diagnose problems.
It is always a good thing to have debug mode on when developing your application. In particular, you may want to have it on if you experiment a core dump when running Java code.
Notice that debug mode introduces a slowdown, so make sure it is set to "off" when you release your application.
The default mode is "on", and this print a warning message on the console (which can be disabled, see setDebugModeWarning(boolean)

setDebugModeWarning

public static void setDebugModeWarning(boolean warning)

Sets the debug-mode warning message on/off. You can call this method to disable the warning message while you are still using debug mode.

registerLicense

public static void registerLicense(java.lang.String license,
                   int signature)
                            throws IloException

Entry point for runtime licenses.

Throws an IloException in case of failure.

This method is deprecated in IBM ILOG CPLEX Optimization Studio V12.3. You need to register licenses for the ILOG CPLEX and ILOG CP Optimizer engines separately, using the methods IloCplex.registerLicense or IloCP.registerLicense.

Throws:

IloException

Parameters:

license - a string containing the RUNTIME key.

signature - an integer associated with the RUNTIME key, obtained with the key.

releaseLicense

public static void releaseLicense()

Forces OPL to release the license it is currently holding. This method is deprecated in IBM ILOG CPLEX Optimization Studio V12.3.

getVersion

public static java.lang.String getVersion()

Returns the version of the OPL library.

createOplCompiler

public IloOplCompiler createOplCompiler()

createCplex

public IloCplex createCplex()
                     throws IloException

Creates a new ILOG CPLEX instance.

Throws:

IloException

createCP

public IloCP createCP()
               throws IloException

Creates a new ILOG CP Optimizer instance.

Throws:

IloException

createOplModelDefinition

@Deprecated
public IloOplModelDefinition createOplModelDefinition(IloOplModelSource source,
                                                        IloOplErrorHandler handler)

Deprecated.

createOplModelDefinition

public IloOplModelDefinition createOplModelDefinition(IloOplModelSource source,
                                             IloOplSettings settings)

createOplProject

public IloOplProject createOplProject(java.lang.String projectPath)

createOplProject

public IloOplProject createOplProject(java.io.InputStream input,
                             java.lang.String name)

createOplRunConfiguration

public IloOplRunConfiguration createOplRunConfiguration(java.lang.String modPath,
                                               java.lang.String datPath)
                                                 throws IloException

Throws:

IloException

createOplRunConfiguration

public IloOplRunConfiguration createOplRunConfiguration(java.lang.String modPath)
                                                 throws IloException

Throws:

IloException

createOplRunConfiguration

public IloOplRunConfiguration createOplRunConfiguration(java.lang.String modPath,
                                               java.lang.String[] datPaths)
                                                 throws IloException

Throws:

IloException

createOplRunConfiguration

public IloOplRunConfiguration createOplRunConfiguration(IloOplModelDefinition def)
                                                 throws IloException

Throws:

IloException

createOplRunConfiguration

public IloOplRunConfiguration createOplRunConfiguration(IloOplModelDefinition def,
                                               IloOplDataElements dataElements)
                                                 throws IloException

Throws:

IloException

createOplErrorHandler

public IloOplErrorHandler createOplErrorHandler(java.io.OutputStream outs)

createOplErrorHandler

public IloOplErrorHandler createOplErrorHandler()

Creates an error handler that display messages on the standard output.

createOplSettings

public IloOplSettings createOplSettings(IloOplErrorHandler handler)

createOplModel

public IloOplModel createOplModel(IloOplModelDefinition definition,
                         IloCplex cplex)

createOplModel

public IloOplModel createOplModel(IloOplModelDefinition definition,
                         IloCP cp)

createOplModelSource

@Deprecated
public IloOplModelSource createOplModelSource(java.lang.String filename,
                                                boolean compiled)

Deprecated.

createOplModelSource

public IloOplModelSource createOplModelSource(java.lang.String filename)

createOplDataElements

public IloOplDataElements createOplDataElements()

createOplModelSourceFromString

public IloOplModelSource createOplModelSourceFromString(java.lang.String modelText,
                                               java.lang.String modelName)

Creates an OPL model source from a model given as a string.

Parameters:

modelText - The text of the model to be used as a source. It can't be a compiled model (which is a binary file).

modelName - The name of the model

createOplModelSourceFromStream

public IloOplModelSource createOplModelSourceFromStream(java.io.InputStream modelStream,
                                               java.lang.String modelName)

Creates an OPL model source from a model given as a stream.

Parameters:

modelStream - The stream of the model to be used as a source. It may be a compiled model.

modelName - The name of the model

createOplModelSourceFromString

@Deprecated
public IloOplModelSource createOplModelSourceFromString(java.lang.String modelText,
                                                          java.lang.String modelName,
                                                          boolean compiled)

Deprecated.

Creates an OPL model source from a model given as a string.

Parameters:

compiled - True if the string contains a compiled model.

createOplDataSource

public IloOplDataSource createOplDataSource(java.lang.String filename)

createOplDataSourceFromString

public IloOplDataSource createOplDataSourceFromString(java.lang.String dataText,
                                             java.lang.String name)

Creates an OPL data source from a set of data given as a string.

Parameters:

dataText - The text of the data to be used as data source

name - The name of the data source

createOplDataSourceFromStream

public IloOplDataSource createOplDataSourceFromStream(java.io.InputStream dataStream,
                                             java.lang.String name)

Creates an OPL data source from a set of data given as a stream.

Parameters:

dataStream - The stream of data to be used as data source

name - The name of the data source

createOplDataSerializer

@Deprecated
public IloOplDataSerializer createOplDataSerializer(java.io.OutputStream outs)

Deprecated.

createOplDataSerializer

public IloOplDataSerializer createOplDataSerializer(IloOplSettings settings,
                                           java.io.OutputStream outs)

IloOplDataSerializer

public IloOplDataSerializer IloOplDataSerializer(IloOplSettings settings,
                                        java.io.OutputStream outs,
                                        boolean header)

createOplCplexBasis

public IloOplCplexBasis createOplCplexBasis()

createOplCplexVectors

public IloOplCplexVectors createOplCplexVectors()

createOplRelaxationIterator

public IloOplRelaxationIterator createOplRelaxationIterator(IloOplModel model)

createOplConflictIterator

public IloOplConflictIterator createOplConflictIterator(IloOplModel model)

createOplProfiler

public IloOplProfiler createOplProfiler()

setOut

public void setOut(java.io.OutputStream outputStream)

Redirects all output messages to the given stream

setError

public void setError(java.io.OutputStream errorStream)

Redirects all error messages to the given stream

setWarning

public void setWarning(java.io.OutputStream warningStream)

Redirects all warning messages to the given stream

end

public void end()

Deletes the OPL environment, clearing all the memory used by the objects created through this factory.
Notice that you cannot call any method on any OPL object (including this one) after this call.

mapIndexArray

public IloMapIndexArray mapIndexArray(int initialSize)
                               throws IloException

Returns an array to manipulate indices to access instances of IloTupleMap.

Throws:

IloException

addToKeepRefs

public void addToKeepRefs(java.lang.Object obj)

removeFromKeepRefs

public void removeFromKeepRefs(java.lang.Object obj)

intRange

public IloIntRange intRange(int lb,
                   int ub)
                     throws IloException

Creates an integer range.

Throws:

IloException

symbolSet

public IloSymbolSet symbolSet()
                       throws IloException

Creates a set of strings.

Throws:

IloException

numSet

public ilog.concert.IloNumSet numSet()
                              throws IloException

Creates a set of numerical values.

Throws:

IloException

intSet

public ilog.concert.IloIntSet intSet()
                              throws IloException

Creates a set of integer values.

Throws:

IloException