Package com.hexaly.optimizer

Enum Class HxCallbackType

java.lang.Object

java.lang.Enum<HxCallbackType>

com.hexaly.optimizer.HxCallbackType

All Implemented Interfaces:

Serializable, Comparable<HxCallbackType>, Constable

public enum HxCallbackType
extends Enum<HxCallbackType>

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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	Description
static HxCallbackType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HxCallbackType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PhaseStarted

public static final HxCallbackType PhaseStarted

Event that occurs when a phase is started.

PhaseEnded

public static final HxCallbackType PhaseEnded

Event that occurs when a phase ends.

Display

public static final HxCallbackType 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:

• HxParam.setTimeBetweenDisplays(int)

TimeTicked

public static final HxCallbackType TimeTicked

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

See Also:

• HxParam.setTimeBetweenTicks(int)

IterationTicked

public static final HxCallbackType 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:

• HxParam.setIterationBetweenTicks(long)

Method Details

values

public static HxCallbackType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static HxCallbackType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null