localsolver

Enum LSCallbackType

java.lang.Object

java.lang.Enum<LSCallbackType>

localsolver.LSCallbackType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LSCallbackType>

public enum LSCallbackType
extends java.lang.Enum<LSCallbackType>

List of types that can be used with callbacks. Each type corresponds to a specific event that can occur during the resolution.

Since:

4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
Display Event that occurs regularly before, after and during the search to display useful information about the model and the resolution.
IterationTicked Event that occurs regularly during the resolution.
PhaseEnded Event that occurs when a phase ends.
PhaseStarted Event that occurs when a phase is started.
TimeTicked Event that occurs regularly during the resolution.

Method Summary

Modifier and Type	Method and Description
static LSCallbackType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LSCallbackType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PhaseStarted

public static final LSCallbackType PhaseStarted

Event that occurs when a phase is started.

PhaseEnded

public static final LSCallbackType PhaseEnded

Event that occurs when a phase ends.

Display

public static final LSCallbackType Display

Event that occurs regularly before, after and during the search to display useful information about the model and the resolution. The time between two such events can be tuned with the timeBetweenDisplays parameter.

See Also:

LSParam.setTimeBetweenDisplays(int)

TimeTicked

public static final LSCallbackType TimeTicked

Event that occurs regularly during the resolution. The time between two such events can be tuned with the timeBetweenTicks parameter.

See Also:

LSParam.setTimeBetweenTicks(int)

IterationTicked

public static final LSCallbackType IterationTicked

Event that occurs regularly during the resolution. The number of iterations between two such events can be tuned with the iterationsBetweenTicked parameter.

See Also:

LSParam.setIterationBetweenTicks(long)

Method Detail

values

public static LSCallbackType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LSCallbackType c : LSCallbackType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LSCallbackType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null