C++ Reference
C++ Reference: Routing
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 3119 of file constraint_solver.h.
Public Member Functions | |
| PropagationBaseObject (Solver *const s) | |
| ~PropagationBaseObject () override | |
| std::string | DebugString () const override |
| Solver * | solver () const |
| void | FreezeQueue () |
| This method freezes the propagation queue. More... | |
| void | UnfreezeQueue () |
| This method unfreezes the propagation queue. More... | |
| void | EnqueueDelayedDemon (Demon *const d) |
| This method pushes the demon onto the propagation queue. More... | |
| void | EnqueueVar (Demon *const d) |
| void | ExecuteAll (const SimpleRevFIFO< Demon * > &demons) |
| void | EnqueueAll (const SimpleRevFIFO< Demon * > &demons) |
| void | set_action_on_fail (Solver::Action a) |
| 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... | |
| virtual std::string | name () const |
| Object naming. More... | |
| void | set_name (const std::string &name) |
| bool | HasName () const |
| Returns whether the object has been named or not. More... | |
| virtual std::string | BaseName () const |
| Returns a base name for automatic naming. More... | |
Constructor & Destructor Documentation
◆ PropagationBaseObject()
|
inlineexplicit |
Definition at line 3121 of file constraint_solver.h.
◆ ~PropagationBaseObject()
|
inlineoverride |
Definition at line 3122 of file constraint_solver.h.
Member Function Documentation
◆ BaseName()
|
virtual |
Returns a base name for automatic naming.
Reimplemented in BooleanVar.
◆ DebugString()
|
inlineoverridevirtual |
Reimplemented from BaseObject.
Reimplemented in Pack, Assignment, SequenceVar, Constraint, BooleanVar, and GlobalVehicleBreaksConstraint.
Definition at line 3124 of file constraint_solver.h.
◆ EnqueueAll()
| void EnqueueAll | ( | const SimpleRevFIFO< Demon * > & | demons | ) |
◆ EnqueueDelayedDemon()
|
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 3144 of file constraint_solver.h.
◆ EnqueueVar()
|
inline |
Definition at line 3145 of file constraint_solver.h.
◆ ExecuteAll()
| void ExecuteAll | ( | const SimpleRevFIFO< Demon * > & | demons | ) |
◆ FreezeQueue()
|
inline |
This method freezes the propagation queue.
It is useful when you need to apply multiple modifications at once.
Definition at line 3135 of file constraint_solver.h.
◆ HasName()
| bool HasName | ( | ) | const |
Returns whether the object has been named or not.
◆ name()
|
virtual |
Object naming.
◆ reset_action_on_fail()
|
inline |
This method clears the failure callback.
Definition at line 3158 of file constraint_solver.h.
◆ set_action_on_fail()
|
inline |
Definition at line 3152 of file constraint_solver.h.
◆ set_name()
| void set_name | ( | const std::string & | name | ) |
◆ set_variable_to_clean_on_fail()
|
inline |
Shortcut for variable cleaner.
Definition at line 3161 of file constraint_solver.h.
◆ solver()
|
inline |
Definition at line 3131 of file constraint_solver.h.
◆ UnfreezeQueue()
|
inline |
This method unfreezes the propagation queue.
All modifications that happened when the queue was frozen will be processed.
Definition at line 3139 of file constraint_solver.h.
The documentation for this class was generated from the following file: