operations_research::PropagationBaseObject Class Reference

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

operations_research::PropagationBaseObject::PropagationBaseObject ( Solver *const  s )

inlineexplicit

Definition at line 3106 of file constraint_solver.h.

~PropagationBaseObject()

operations_research::PropagationBaseObject::~PropagationBaseObject ( )

inlineoverride

Definition at line 3107 of file constraint_solver.h.

Member Function Documentation

BaseName()

virtual std::string operations_research::PropagationBaseObject::BaseName ( ) const

virtual

Returns a base name for automatic naming.

Reimplemented in operations_research::BooleanVar.

DebugString()

std::string operations_research::PropagationBaseObject::DebugString ( ) const

inlineoverridevirtual

Reimplemented from operations_research::BaseObject.

Reimplemented in operations_research::Pack, operations_research::Assignment, operations_research::SequenceVar, operations_research::Constraint, and operations_research::BooleanVar.

Definition at line 3109 of file constraint_solver.h.

EnqueueAll()

void operations_research::PropagationBaseObject::EnqueueAll

(

const SimpleRevFIFO< Demon * > &

demons

)

EnqueueDelayedDemon()

void operations_research::PropagationBaseObject::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 3129 of file constraint_solver.h.

EnqueueVar()

void operations_research::PropagationBaseObject::EnqueueVar ( Demon *const  d )

inline

Definition at line 3130 of file constraint_solver.h.

ExecuteAll()

void operations_research::PropagationBaseObject::ExecuteAll

(

const SimpleRevFIFO< Demon * > &

demons

)

FreezeQueue()

void operations_research::PropagationBaseObject::FreezeQueue ( )

inline

This method freezes the propagation queue.

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

Definition at line 3120 of file constraint_solver.h.

HasName()

bool operations_research::PropagationBaseObject::HasName

(

)

const

Returns whether the object has been named or not.

name()

virtual std::string operations_research::PropagationBaseObject::name ( ) const

virtual

Object naming.

reset_action_on_fail()

void operations_research::PropagationBaseObject::reset_action_on_fail ( )

inline

This method clears the failure callback.

Definition at line 3143 of file constraint_solver.h.

set_action_on_fail()

void operations_research::PropagationBaseObject::set_action_on_fail ( Solver::Action  a )

inline

Definition at line 3137 of file constraint_solver.h.

set_name()

void operations_research::PropagationBaseObject::set_name

(

const std::string &

name

)

set_variable_to_clean_on_fail()

void operations_research::PropagationBaseObject::set_variable_to_clean_on_fail ( IntVar *  v )

inline

Shortcut for variable cleaner.

Definition at line 3146 of file constraint_solver.h.

solver()

Solver* operations_research::PropagationBaseObject::solver ( ) const

inline

Definition at line 3116 of file constraint_solver.h.

UnfreezeQueue()

void operations_research::PropagationBaseObject::UnfreezeQueue ( )

inline

This method unfreezes the propagation queue.

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

Definition at line 3124 of file constraint_solver.h.

---

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

• constraint_solver.h