ilog.cplex

Interface IloCplex.Callback.Function

Enclosing class:

IloCplex.Callback

public static interface IloCplex.Callback.Function

Interface for CPLEX callbacks.

Any class to be used as a CPLEX callback must implement this interface. See the documentation of IloCplex.use(Callback.Function,long) for more details.

Method Summary

Methods

Modifier and Type	Method and Description
void	invoke(IloCplex.Callback.Context context) Invokes the CPLEX callback.

Method Detail

invoke

void invoke(IloCplex.Callback.Context context)
            throws IloException

Invokes the CPLEX callback.

If an object is registered with CPLEX by means of IloCplex.use(Callback.Function,long), then CPLEX will invoke this function of the registered object in all contexts requested by the contextMask passed to IloCplex.use(Callback.Function,long).

Note that in this function you must not invoke any functions of the IloCplex instance that is performing the current solve. All functions that can be invoked from a callback are members of context.

Throws:

IloException - in order to indicate any sort of error.

Parameters:

context - An instance of IloCplex.Callback.Context that defines in which context the callback is invoked, which progress information can be queried, and which actions can be performed. This instance is valid only during execution of the callback function. The user must not keep a reference to it.