choco.prop
Interface PropagationEvent

All Known Implementing Classes:

ConstraintEvent, IntVarEvent, PalmIntVarEvent, PalmRealVarEvent, RealVarEvent, SetVarEvent, VarEvent

public interface PropagationEvent

An interface for all implementations of events.

Field Summary

static int

POPPING Value of the state in the queue: -1 means the var is being propagated.

Method Summary

void	clear() Clears the var if it not useful anymore.
java.lang.Object	getModifiedObject() Returns the object, whose modification is described by the event
boolean	isActive(int idx) Tests whether a propagation var is active in the propagation network.
boolean	propagateEvent() Propagates the var through calls to the propagation engine.

Field Detail

POPPING

static final int POPPING

Value of the state in the queue: -1 means the var is being propagated. (see VarEvent.qState)

See Also:

Constant Field Values

Method Detail

getModifiedObject

java.lang.Object getModifiedObject()

Returns the object, whose modification is described by the event

propagateEvent

boolean propagateEvent()
                       throws ContradictionException

Propagates the var through calls to the propagation engine.

Returns:

true if the event has been fully propagated (and can thus be discarded), false otherwise

Throws:

ContradictionException

isActive

boolean isActive(int idx)

Tests whether a propagation var is active in the propagation network.

clear

void clear()

Clears the var if it not useful anymore.