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 3262 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()

PropagationBaseObject ( Solver *const  s )

inlineexplicit

Definition at line 3264 of file constraint_solver.h.

~PropagationBaseObject()

~PropagationBaseObject ( )

inlineoverride

Definition at line 3265 of file constraint_solver.h.

Member Function Documentation

BaseName()

std::string BaseName ( ) const

virtual

Returns a base name for automatic naming.

Reimplemented in BooleanVar.

Definition at line 2549 of file constraint_solver.cc.

DebugString()

std::string DebugString ( ) const

inlineoverridevirtual

Reimplemented from BaseObject.

Reimplemented in GlobalVehicleBreaksConstraint, PiecewiseLinearExpr, IfThenElseCt, BooleanVar, LightIntIntFunctionElementCt< F >, LightIntFunctionElementCt< F >, Pack, Assignment, SequenceVar, and Constraint.

Definition at line 3267 of file constraint_solver.h.

EnqueueAll()

void EnqueueAll

(

const SimpleRevFIFO< Demon * > &

demons

)

Definition at line 2555 of file constraint_solver.cc.

EnqueueDelayedDemon()

void EnqueueDelayedDemon ( Demon *const  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 3287 of file constraint_solver.h.

EnqueueVar()

void EnqueueVar ( Demon *const  d )

inline

Definition at line 3288 of file constraint_solver.h.

ExecuteAll()

void ExecuteAll

(

const SimpleRevFIFO< Demon * > &

demons

)

Definition at line 2551 of file constraint_solver.cc.

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 3278 of file constraint_solver.h.

HasName()

bool HasName

(

)

const

Returns whether the object has been named or not.

Definition at line 2547 of file constraint_solver.cc.

name()

std::string name ( ) const

virtual

Object naming.

Reimplemented in PiecewiseLinearExpr.

Definition at line 2539 of file constraint_solver.cc.

reset_action_on_fail()

void reset_action_on_fail ( )

inline

This method clears the failure callback.

Definition at line 3301 of file constraint_solver.h.

set_action_on_fail()

void set_action_on_fail ( Solver::Action  a )

inline

Definition at line 3295 of file constraint_solver.h.

set_name()

void set_name

(

const std::string &

name

)

Definition at line 2543 of file constraint_solver.cc.

set_variable_to_clean_on_fail()

void set_variable_to_clean_on_fail ( IntVar *  v )

inline

Shortcut for variable cleaner.

Definition at line 3304 of file constraint_solver.h.

solver()

Solver* solver ( ) const

inline

Definition at line 3274 of file constraint_solver.h.

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 3282 of file constraint_solver.h.

---

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

• constraint_solver.h
• constraint_solver.cc