Java Reference

Java Reference

PropagationBaseObject

Detailed Description

NOLINT The PropagationBaseObject is a subclass of BaseObject that is also friend to the Solver class.

It allows accessing methods useful when writing new constraints or new expressions.

Definition at line 14 of file PropagationBaseObject.java.

Public Member Functions

synchronized void delete ()
 
 PropagationBaseObject (Solver s)
 
String toString ()
 
Solver solver ()
 
void freezeQueue ()
 This method freezes the propagation queue. More...
 
void unfreezeQueue ()
 This method unfreezes the propagation queue. More...
 
void enqueueDelayedDemon (Demon d)
 This method pushes the demon onto the propagation queue. More...
 
void enqueueVar (Demon d)
 
void reset_action_on_fail ()
 This method clears the failure callback. More...
 
void set_variable_to_clean_on_fail (IntVar v)
 Shortcut for variable cleaner. More...
 
String name ()
 Object naming. More...
 
void setName (String name)
 
boolean hasName ()
 Returns whether the object has been named or not. More...
 
String baseName ()
 Returns a base name for automatic naming. More...
 

Protected Member Functions

 PropagationBaseObject (long cPtr, boolean cMemoryOwn)
 

Constructor & Destructor Documentation

◆ PropagationBaseObject() [1/2]

PropagationBaseObject ( long  cPtr,
boolean  cMemoryOwn 
)
inlineprotected

Definition at line 17 of file PropagationBaseObject.java.

◆ PropagationBaseObject() [2/2]

Definition at line 42 of file PropagationBaseObject.java.

Member Function Documentation

◆ baseName()

String baseName ( )
inline

Returns a base name for automatic naming.

Reimplemented in BooleanVar.

Definition at line 115 of file PropagationBaseObject.java.

◆ delete()

◆ enqueueDelayedDemon()

void enqueueDelayedDemon ( Demon  d)
inline

This method pushes the demon onto the propagation queue.

It will be processed directly if the queue is empty. It will be enqueued according to its priority otherwise.

Definition at line 72 of file PropagationBaseObject.java.

◆ enqueueVar()

void enqueueVar ( Demon  d)
inline

Definition at line 76 of file PropagationBaseObject.java.

◆ freezeQueue()

void freezeQueue ( )
inline

This method freezes the propagation queue.

It is useful when you need to apply multiple modifications at once.

Definition at line 58 of file PropagationBaseObject.java.

◆ hasName()

boolean hasName ( )
inline

Returns whether the object has been named or not.

Definition at line 108 of file PropagationBaseObject.java.

◆ name()

String name ( )
inline

Object naming.

Definition at line 97 of file PropagationBaseObject.java.

◆ reset_action_on_fail()

void reset_action_on_fail ( )
inline

This method clears the failure callback.

Definition at line 83 of file PropagationBaseObject.java.

◆ set_variable_to_clean_on_fail()

void set_variable_to_clean_on_fail ( IntVar  v)
inline

Shortcut for variable cleaner.

Definition at line 90 of file PropagationBaseObject.java.

◆ setName()

void setName ( String  name)
inline

Definition at line 101 of file PropagationBaseObject.java.

◆ solver()

Solver solver ( )
inline

Definition at line 50 of file PropagationBaseObject.java.

◆ toString()

String toString ( )
inline

Reimplemented from BaseObject.

Reimplemented in Assignment, Pack, BooleanVar, Constraint, GlobalVehicleBreaksConstraint, and SequenceVar.

Definition at line 46 of file PropagationBaseObject.java.

◆ unfreezeQueue()

void unfreezeQueue ( )
inline

This method unfreezes the propagation queue.

All modifications that happened when the queue was frozen will be processed.

Definition at line 65 of file PropagationBaseObject.java.


The documentation for this class was generated from the following file: