choco.cp.solver.variables.set
Class SetVarEvent<C extends AbstractSConstraint & SetPropagator>

java.lang.Object
  extended by choco.kernel.solver.propagation.event.VarEvent<SetVarImpl>
      extended by choco.cp.solver.variables.set.SetVarEvent<C>
All Implemented Interfaces:
IPrioritizable, PropagationEvent

public class SetVarEvent<C extends AbstractSConstraint & SetPropagator>
extends VarEvent<SetVarImpl>


Field Summary
static int ADDKER
           
static int ADDKER_MASK
           
static int ENVEVENT
          Deprecated. 
static int INSTSET
           
static int INSTSET_MASK
           
static int INSTSETEVENT
          Deprecated. 
static int KEREVENT
          Deprecated. 
static int REMENV
          Constants for the eventType bitvector: index of bit for events on SetVars
static int REMENV_MASK
           
 
Fields inherited from class choco.kernel.solver.propagation.event.VarEvent
cause, DOWDCAUSE, EMPTYEVENT, eventType, modifiedVar, NOCAUSE, NOEVENT, propagatedEvents
 
Fields inherited from interface choco.kernel.solver.propagation.event.PropagationEvent
LOGGER
 
Constructor Summary
SetVarEvent(SetVarImpl var)
           
 
Method Summary
 void clear()
          Clears the var: delegates to the basic events.
protected  void freeze()
          freezes the state of the "delta domain": the set of values that are considered for removal from the domain.
 boolean getReleased()
           
 void propagateEnveloppeEvents(C evtCause)
          Propagates a set of value removals
 boolean propagateEvent()
          Propagates the event through calls to the propagation engine.
 void propagateInstEvent(C evtCause)
          Propagates the instantiation event
 void propagateKernelEvents(C evtCause)
          Propagates a set of value removals
 void recordEventTypeAndCause(int basicEvt, SConstraint constraint, boolean forceAwake)
           
protected  boolean release()
           
 String toString()
          useful for debugging
 
Methods inherited from class choco.kernel.solver.propagation.event.VarEvent
addPropagatedEvents, domOverWDegIdx, domOverWDegInitialIdx, getCause, getEventType, getModifiedObject, getModifiedVar, getPriority, getPropagatedEvents, isActive, isEnqueued
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

REMENV

public static final int REMENV
Constants for the eventType bitvector: index of bit for events on SetVars

See Also:
Constant Field Values

ADDKER

public static final int ADDKER
See Also:
Constant Field Values

INSTSET

public static final int INSTSET
See Also:
Constant Field Values

REMENV_MASK

public static final int REMENV_MASK
See Also:
Constant Field Values

ENVEVENT

@Deprecated
public static final int ENVEVENT
Deprecated. 
See Also:
Constant Field Values

ADDKER_MASK

public static final int ADDKER_MASK
See Also:
Constant Field Values

KEREVENT

@Deprecated
public static final int KEREVENT
Deprecated. 
See Also:
Constant Field Values

INSTSET_MASK

public static final int INSTSET_MASK
See Also:
Constant Field Values

INSTSETEVENT

@Deprecated
public static final int INSTSETEVENT
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

SetVarEvent

public SetVarEvent(SetVarImpl var)
Method Detail

toString

public String toString()
useful for debugging

Overrides:
toString in class Object

clear

public void clear()
Clears the var: delegates to the basic events.

Specified by:
clear in interface PropagationEvent
Specified by:
clear in class VarEvent<SetVarImpl>

freeze

protected void freeze()
Description copied from class: VarEvent
freezes the state of the "delta domain": the set of values that are considered for removal from the domain. Further removals will be treated as a further event.

Overrides:
freeze in class VarEvent<SetVarImpl>

release

protected boolean release()
Overrides:
release in class VarEvent<SetVarImpl>

getReleased

public boolean getReleased()

propagateEvent

public boolean propagateEvent()
                       throws ContradictionException
Propagates the event through calls to the propagation engine.

Specified by:
propagateEvent in interface PropagationEvent
Specified by:
propagateEvent in class VarEvent<SetVarImpl>
Returns:
true if the event has been fully propagated (and can thus be discarded), false otherwise
Throws:
ContradictionException

propagateInstEvent

public void propagateInstEvent(C evtCause)
                        throws ContradictionException
Propagates the instantiation event

Throws:
ContradictionException

propagateKernelEvents

public void propagateKernelEvents(C evtCause)
                           throws ContradictionException
Propagates a set of value removals

Throws:
ContradictionException

propagateEnveloppeEvents

public void propagateEnveloppeEvents(C evtCause)
                              throws ContradictionException
Propagates a set of value removals

Throws:
ContradictionException

recordEventTypeAndCause

public void recordEventTypeAndCause(int basicEvt,
                                    SConstraint constraint,
                                    boolean forceAwake)
Overrides:
recordEventTypeAndCause in class VarEvent<SetVarImpl>


Copyright © 2012. All Rights Reserved.