ilog.cplex

Class IloCplex.ParameterSet

java.lang.Object

ilog.cplex.IloCplex.ParameterSet

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

IloCplex

public static class IloCplex.ParameterSet
extends java.lang.Object
implements java.io.Serializable

A parameter set for IloCplex.

This class allows you to store and restore parameters not at their default values.

IloCplex.ParameterSet objects can be created empty with the constructor and then modified. They can also be created by the method IloCplex.getParameterSet.

A parameter set can be applied to an instance of IloCplex by means of IloCplex.setParameterSet(set).

See Also:

IloCplex.getParameterSet(), IloCplex.setParameterSet(ilog.cplex.IloCplex.ParameterSet), IloCplex.readParameterSet(java.lang.String), IloCplex.writeParameterSet(ilog.cplex.IloCplex.ParameterSet, java.lang.String), Serialized Form

Constructor Summary

Constructors

Constructor and Description
IloCplex.ParameterSet()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears the parameter set.
boolean	getParam(IloCplex.BooleanParam which) Returns the current value of a Boolean parameter.
double	getParam(IloCplex.DoubleParam which) Returns the current value of a double parameter.
int	getParam(IloCplex.IntParam which) Returns the current value of an integer parameter.
long	getParam(IloCplex.LongParam which) Returns the current value of an integer parameter.
java.lang.String	getParam(IloCplex.StringParam which) Returns the current value of a string parameter.
java.util.Iterator	iterator()
void	setParam(IloCplex.BooleanParam which, boolean val) Sets a Boolean parameter to value val.
void	setParam(IloCplex.DoubleParam which, double val) Sets a double parameter to value val.
void	setParam(IloCplex.IntParam which, int val) Sets an integer parameter to value val.
void	setParam(IloCplex.LongParam which, long val) Sets an integer parameter to value val.
void	setParam(IloCplex.StringParam which, java.lang.String val) Sets a string parameter to value val.

Methods inherited from class java.lang.Object

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

Constructor Detail

IloCplex.ParameterSet

public IloCplex.ParameterSet()

Method Detail

clear

public void clear()

Clears the parameter set.

setParam

public void setParam(IloCplex.IntParam which,
            int val)

Sets an integer parameter to value val.

Parameters:

which - The identifier of the parameter to set.

val - The new value for the integer parameter.

setParam

public void setParam(IloCplex.LongParam which,
            long val)

Sets an integer parameter to value val.

Parameters:

which - The identifier of the parameter to set.

val - The new value for the integer parameter.

setParam

public void setParam(IloCplex.StringParam which,
            java.lang.String val)

Sets a string parameter to value val.

Parameters:

which - The identifier of the string parameter to set.

val - The new value for the string parameter.

setParam

public void setParam(IloCplex.BooleanParam which,
            boolean val)

Sets a Boolean parameter to value val.

Parameters:

which - The identifier of the Boolean parameter to be set.

val - The new value for the Boolean parameter.

setParam

public void setParam(IloCplex.DoubleParam which,
            double val)

Sets a double parameter to value val.

Parameters:

which - The identifier of the double parameter to be set.

val - The new value for the double parameter

getParam

public int getParam(IloCplex.IntParam which)
             throws IloException

Returns the current value of an integer parameter.

Throws:

IloException - If the method fails, an exception of type IloException, or one of its derived classes, is thrown.

Parameters:

which - The identifier of the integer parameter to be queried.

Returns:

The current value of the integer parameter.

getParam

public long getParam(IloCplex.LongParam which)
              throws IloException

Returns the current value of an integer parameter.

Throws:

IloException - If the method fails, an exception of type IloException, or one of its derived classes, is thrown.

Parameters:

which - The identifier of the integer parameter to be queried.

Returns:

The current value of the integer parameter.

getParam

public java.lang.String getParam(IloCplex.StringParam which)
                          throws IloException

Returns the current value of a string parameter.

Throws:

IloException - If the method fails, an exception of type IloException, or one of its derived classes, is thrown.

Parameters:

which - The identifier of the string parameter to be queried.

Returns:

The current value of the string parameter.

getParam

public boolean getParam(IloCplex.BooleanParam which)
                 throws IloException

Returns the current value of a Boolean parameter.

Throws:

IloException - If the method fails, an exception of type IloException, or one of its derived classes, is thrown.

Parameters:

which - The identifier of the Boolean parameter to be queried.

Returns:

The current value of the Boolean parameter.

getParam

public double getParam(IloCplex.DoubleParam which)
                throws IloException

Returns the current value of a double parameter.

Throws:

IloException - If the method fails, an exception of type IloException, or one of its derived classes, is thrown.

Parameters:

which - The identifier of the double parameter to be queried.

Returns:

The current value of the double parameter.

iterator

public java.util.Iterator iterator()