ilog.cplex

Class IloCplex.Callback.Context.Id

java.lang.Object

ilog.cplex.IloCplex.Callback.Context.Id

Enclosing class:

IloCplex.Callback.Context

public static final class IloCplex.Callback.Context.Id
extends java.lang.Object

Places in which a CPLEX callback can be invoked.

The values defined here specify in which contexts CPLEX can invoke a callback. They are used in two different ways:

• The are used as arguments to IloCplex.Callback.Function.invoke(ilog.cplex.IloCplex.Callback.Context) to indicate in which context the callback has just been invoked.
• A bit-wise OR of these values is used as argument to IloCplex.use(Callback.Function,long) to specify in which places CPLEX should invoke the registered callback.

For details about the various context values, refer to Callback context in the Reference Manual of the Callable Library (C API) for further details about these values. reference documentation.

Important notes about the ThreadDown context:

• If a callback invoked in ThreadUp context throws an exception then ThreadDown will not be invoked on this thread!
• The callback function is not allowed to throw exceptions if invoked in context ThreadDown. Any exception thrown in this context will be ignored.

You may think of ThreadUp and ThreadDown as "constructor" and "destructor": the destructor is only invoked if the object was fully constructed and is not allowed to throw an exception.

Field Summary

Fields

Modifier and Type	Field and Description
static long	Branching See CPX_CALLBACKCONTEXT_BRANCHING in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.
static long	Candidate See CPX_CALLBACKCONTEXT_CANDIDATE in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.
static long	GlobalProgress See CPX_CALLBACKCONTEXT_GLOBAL_PROGRESS in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.
static long	LocalProgress See CPX_CALLBACKCONTEXT_LOCAL_PREOGRESS in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.
static long	Relaxation See CPX_CALLBACKCONTEXT_RELAXATION in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.
static long	ThreadDown See CPX_CALLBACKCONTEXT_THREAD_DOWN in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.
static long	ThreadUp See CPX_CALLBACKCONTEXT_THREAD_UP in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

ThreadUp

public static final long ThreadUp

See CPX_CALLBACKCONTEXT_THREAD_UP in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.

See Also:

Constant Field Values

ThreadDown

public static final long ThreadDown

See CPX_CALLBACKCONTEXT_THREAD_DOWN in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.

See Also:

Constant Field Values

LocalProgress

public static final long LocalProgress

See CPX_CALLBACKCONTEXT_LOCAL_PREOGRESS in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.

See Also:

Constant Field Values

GlobalProgress

public static final long GlobalProgress

See CPX_CALLBACKCONTEXT_GLOBAL_PROGRESS in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.

See Also:

Constant Field Values

Candidate

public static final long Candidate

See CPX_CALLBACKCONTEXT_CANDIDATE in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.

See Also:

Constant Field Values

Relaxation

public static final long Relaxation

See CPX_CALLBACKCONTEXT_RELAXATION in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.

See Also:

Constant Field Values

Branching

public static final long Branching

See CPX_CALLBACKCONTEXT_BRANCHING in the topic Callback context among the macros of the Reference Manual of the Callable Library (C API) for further details.

See Also:

Constant Field Values