![]() |
OR-Tools
8.2
|
Interval variables are often used in scheduling.
The main characteristics of an IntervalVar are the start position, duration, and end date. All these characteristics can be queried and set, and demons can be posted on their modifications.
An important aspect is optionality: an IntervalVar can be performed or not. If unperformed, then it simply does not exist, and its characteristics cannot be accessed any more. An interval var is automatically marked as unperformed when it is not consistent anymore (start greater than end, duration < 0...)
Definition at line 4394 of file constraint_solver.h.
Public Member Functions | |
IntervalVar (Solver *const solver, const std::string &name) | |
~IntervalVar () override | |
virtual int64 | StartMin () const =0 |
These methods query, set, and watch the start position of the interval var. More... | |
virtual int64 | StartMax () const =0 |
virtual void | SetStartMin (int64 m)=0 |
virtual void | SetStartMax (int64 m)=0 |
virtual void | SetStartRange (int64 mi, int64 ma)=0 |
virtual int64 | OldStartMin () const =0 |
virtual int64 | OldStartMax () const =0 |
virtual void | WhenStartRange (Demon *const d)=0 |
void | WhenStartRange (Solver::Closure closure) |
void | WhenStartRange (Solver::Action action) |
virtual void | WhenStartBound (Demon *const d)=0 |
void | WhenStartBound (Solver::Closure closure) |
void | WhenStartBound (Solver::Action action) |
virtual int64 | DurationMin () const =0 |
These methods query, set, and watch the duration of the interval var. More... | |
virtual int64 | DurationMax () const =0 |
virtual void | SetDurationMin (int64 m)=0 |
virtual void | SetDurationMax (int64 m)=0 |
virtual void | SetDurationRange (int64 mi, int64 ma)=0 |
virtual int64 | OldDurationMin () const =0 |
virtual int64 | OldDurationMax () const =0 |
virtual void | WhenDurationRange (Demon *const d)=0 |
void | WhenDurationRange (Solver::Closure closure) |
void | WhenDurationRange (Solver::Action action) |
virtual void | WhenDurationBound (Demon *const d)=0 |
void | WhenDurationBound (Solver::Closure closure) |
void | WhenDurationBound (Solver::Action action) |
virtual int64 | EndMin () const =0 |
These methods query, set, and watch the end position of the interval var. More... | |
virtual int64 | EndMax () const =0 |
virtual void | SetEndMin (int64 m)=0 |
virtual void | SetEndMax (int64 m)=0 |
virtual void | SetEndRange (int64 mi, int64 ma)=0 |
virtual int64 | OldEndMin () const =0 |
virtual int64 | OldEndMax () const =0 |
virtual void | WhenEndRange (Demon *const d)=0 |
void | WhenEndRange (Solver::Closure closure) |
void | WhenEndRange (Solver::Action action) |
virtual void | WhenEndBound (Demon *const d)=0 |
void | WhenEndBound (Solver::Closure closure) |
void | WhenEndBound (Solver::Action action) |
virtual bool | MustBePerformed () const =0 |
These methods query, set, and watch the performed status of the interval var. More... | |
virtual bool | MayBePerformed () const =0 |
bool | CannotBePerformed () const |
bool | IsPerformedBound () const |
virtual void | SetPerformed (bool val)=0 |
virtual bool | WasPerformedBound () const =0 |
virtual void | WhenPerformedBound (Demon *const d)=0 |
void | WhenPerformedBound (Solver::Closure closure) |
void | WhenPerformedBound (Solver::Action action) |
void | WhenAnything (Demon *const d) |
Attaches a demon awakened when anything about this interval changes. More... | |
void | WhenAnything (Solver::Closure closure) |
Attaches a closure awakened when anything about this interval changes. More... | |
void | WhenAnything (Solver::Action action) |
Attaches an action awakened when anything about this interval changes. More... | |
virtual IntExpr * | StartExpr ()=0 |
These methods create expressions encapsulating the start, end and duration of the interval var. More... | |
virtual IntExpr * | DurationExpr ()=0 |
virtual IntExpr * | EndExpr ()=0 |
virtual IntExpr * | PerformedExpr ()=0 |
virtual IntExpr * | SafeStartExpr (int64 unperformed_value)=0 |
These methods create expressions encapsulating the start, end and duration of the interval var. More... | |
virtual IntExpr * | SafeDurationExpr (int64 unperformed_value)=0 |
virtual IntExpr * | SafeEndExpr (int64 unperformed_value)=0 |
virtual void | Accept (ModelVisitor *const visitor) const =0 |
Accepts the given visitor. More... | |
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... | |
Static Public Attributes | |
static const int64 | kMinValidValue = -kMaxValidValue |
The smallest acceptable value to be returned by StartMin() More... | |
static const int64 | kMaxValidValue = kint64max >> 2 |
The largest acceptable value to be returned by EndMax() More... | |
|
inline |
Definition at line 4400 of file constraint_solver.h.
|
inlineoverride |
Definition at line 4404 of file constraint_solver.h.
|
pure virtual |
Accepts the given visitor.
|
virtualinherited |
Returns a base name for automatic naming.
Reimplemented in BooleanVar.
Definition at line 2515 of file constraint_solver.cc.
|
inline |
Definition at line 4492 of file constraint_solver.h.
|
inlineoverridevirtualinherited |
Reimplemented from BaseObject.
Reimplemented in Constraint, SequenceVar, Assignment, Pack, BooleanVar, IfThenElseCt, PiecewiseLinearExpr, and GlobalVehicleBreaksConstraint.
Definition at line 3172 of file constraint_solver.h.
|
pure virtual |
|
pure virtual |
|
pure virtual |
These methods query, set, and watch the duration of the interval var.
|
pure virtual |
|
pure virtual |
|
pure virtual |
These methods query, set, and watch the end position of the interval var.
|
inherited |
Definition at line 2521 of file constraint_solver.cc.
|
inlineinherited |
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 3192 of file constraint_solver.h.
|
inlineinherited |
Definition at line 3193 of file constraint_solver.h.
|
inherited |
Definition at line 2517 of file constraint_solver.cc.
|
inlineinherited |
This method freezes the propagation queue.
It is useful when you need to apply multiple modifications at once.
Definition at line 3183 of file constraint_solver.h.
|
inherited |
Returns whether the object has been named or not.
Definition at line 2513 of file constraint_solver.cc.
|
inline |
Definition at line 4493 of file constraint_solver.h.
|
pure virtual |
|
pure virtual |
These methods query, set, and watch the performed status of the interval var.
|
virtualinherited |
Object naming.
Reimplemented in PiecewiseLinearExpr.
Definition at line 2505 of file constraint_solver.cc.
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
inlineinherited |
This method clears the failure callback.
Definition at line 3206 of file constraint_solver.h.
These methods create expressions encapsulating the start, end and duration of the interval var.
If the interval var is unperformed, they will return the unperformed_value.
|
inlineinherited |
Definition at line 3200 of file constraint_solver.h.
|
inherited |
Definition at line 2509 of file constraint_solver.cc.
|
inlineinherited |
Shortcut for variable cleaner.
Definition at line 3209 of file constraint_solver.h.
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
inlineinherited |
Definition at line 3179 of file constraint_solver.h.
|
pure virtual |
These methods create expressions encapsulating the start, end and duration of the interval var.
Please note that these must not be used if the interval var is unperformed.
|
pure virtual |
|
pure virtual |
These methods query, set, and watch the start position of the interval var.
|
inlineinherited |
This method unfreezes the propagation queue.
All modifications that happened when the queue was frozen will be processed.
Definition at line 3187 of file constraint_solver.h.
|
pure virtual |
void WhenAnything | ( | Demon *const | d | ) |
Attaches a demon awakened when anything about this interval changes.
Definition at line 2227 of file interval.cc.
|
inline |
Attaches an action awakened when anything about this interval changes.
Definition at line 4516 of file constraint_solver.h.
|
inline |
Attaches a closure awakened when anything about this interval changes.
Definition at line 4511 of file constraint_solver.h.
|
pure virtual |
|
inline |
Definition at line 4456 of file constraint_solver.h.
|
inline |
Definition at line 4452 of file constraint_solver.h.
|
pure virtual |
|
inline |
Definition at line 4447 of file constraint_solver.h.
|
inline |
Definition at line 4443 of file constraint_solver.h.
|
pure virtual |
|
inline |
Definition at line 4483 of file constraint_solver.h.
|
inline |
Definition at line 4479 of file constraint_solver.h.
|
pure virtual |
|
inline |
Definition at line 4474 of file constraint_solver.h.
|
inline |
Definition at line 4470 of file constraint_solver.h.
|
pure virtual |
|
inline |
Definition at line 4503 of file constraint_solver.h.
|
inline |
Definition at line 4499 of file constraint_solver.h.
|
pure virtual |
|
inline |
Definition at line 4429 of file constraint_solver.h.
|
inline |
Definition at line 4425 of file constraint_solver.h.
|
pure virtual |
|
inline |
Definition at line 4420 of file constraint_solver.h.
|
inline |
Definition at line 4416 of file constraint_solver.h.
The largest acceptable value to be returned by EndMax()
Definition at line 4399 of file constraint_solver.h.
|
static |
The smallest acceptable value to be returned by StartMin()
Definition at line 4397 of file constraint_solver.h.