Java Reference

Java Reference

GlobalVehicleBreaksConstraint

Detailed Description

GlobalVehicleBreaksConstraint ensures breaks constraints are enforced on all vehicles in the dimension passed to its constructor.

It is intended to be used for dimensions representing time. A break constraint ensures break intervals fit on the route of a vehicle. For a given vehicle, it forces break intervals to be disjoint from visit intervals, where visit intervals start at CumulVar(node) and last for node_visit_transit[node]. Moreover, it ensures that there is enough time between two consecutive nodes of a route to do transit and vehicle breaks, i.e. if Next(nodeA) = nodeB, CumulVar(nodeA) = tA and CumulVar(nodeB) = tB, then SlackVar(nodeA) >= sum_{breaks [tA, tB)} duration(break).

Definition at line 14 of file GlobalVehicleBreaksConstraint.java.

Public Member Functions

synchronized void delete ()
 
 GlobalVehicleBreaksConstraint (RoutingDimension dimension)
 
String toString ()
 
void post ()
 This method is called when the constraint is processed by the solver. More...
 
void initialPropagate ()
 This method performs the initial propagation of the constraint. More...
 
void postAndPropagate ()
 Calls Post and then Propagate to initialize the constraints. More...
 
void accept (ModelVisitor visitor)
 Accepts the given visitor. More...
 
boolean isCastConstraint ()
 Is the constraint created by a cast from expression to integer variable? More...
 
IntVar var ()
 Creates a Boolean variable representing the status of the constraint (false = constraint is violated, true = constraint is satisfied). More...
 
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

 GlobalVehicleBreaksConstraint (long cPtr, boolean cMemoryOwn)
 

Constructor & Destructor Documentation

◆ GlobalVehicleBreaksConstraint() [1/2]

GlobalVehicleBreaksConstraint ( long  cPtr,
boolean  cMemoryOwn 
)
inlineprotected

Definition at line 17 of file GlobalVehicleBreaksConstraint.java.

◆ GlobalVehicleBreaksConstraint() [2/2]

Definition at line 42 of file GlobalVehicleBreaksConstraint.java.

Member Function Documentation

◆ accept()

void accept ( ModelVisitor  visitor)
inlineinherited

Accepts the given visitor.

Reimplemented in Pack.

Definition at line 70 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.

◆ baseName()

String baseName ( )
inlineinherited

Returns a base name for automatic naming.

Reimplemented in BooleanVar.

Definition at line 115 of file PropagationBaseObject.java.

◆ delete()

synchronized void delete ( )
inline

Reimplemented from Constraint.

Definition at line 31 of file GlobalVehicleBreaksConstraint.java.

◆ enqueueDelayedDemon()

void enqueueDelayedDemon ( Demon  d)
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 72 of file PropagationBaseObject.java.

◆ enqueueVar()

void enqueueVar ( Demon  d)
inlineinherited

Definition at line 76 of file PropagationBaseObject.java.

◆ freezeQueue()

void freezeQueue ( )
inlineinherited

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

Returns whether the object has been named or not.

Definition at line 108 of file PropagationBaseObject.java.

◆ initialPropagate()

void initialPropagate ( )
inline

This method performs the initial propagation of the constraint.

It is called just after the post.

Reimplemented from Constraint.

Definition at line 54 of file GlobalVehicleBreaksConstraint.java.

◆ isCastConstraint()

boolean isCastConstraint ( )
inlineinherited

Is the constraint created by a cast from expression to integer variable?

Definition at line 77 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.

◆ name()

String name ( )
inlineinherited

Object naming.

Definition at line 97 of file PropagationBaseObject.java.

◆ post()

void post ( )
inline

This method is called when the constraint is processed by the solver.

Its main usage is to attach demons to variables.

Reimplemented from Constraint.

Definition at line 50 of file GlobalVehicleBreaksConstraint.java.

◆ postAndPropagate()

void postAndPropagate ( )
inlineinherited

Calls Post and then Propagate to initialize the constraints.

This is usually done in the root node.

Definition at line 63 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.

◆ reset_action_on_fail()

void reset_action_on_fail ( )
inlineinherited

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)
inlineinherited

Shortcut for variable cleaner.

Definition at line 90 of file PropagationBaseObject.java.

◆ setName()

void setName ( String  name)
inlineinherited

Definition at line 101 of file PropagationBaseObject.java.

◆ solver()

Solver solver ( )
inlineinherited

Definition at line 50 of file PropagationBaseObject.java.

◆ toString()

String toString ( )
inline

Reimplemented from Constraint.

Definition at line 46 of file GlobalVehicleBreaksConstraint.java.

◆ unfreezeQueue()

void unfreezeQueue ( )
inlineinherited

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.

◆ var()

IntVar var ( )
inlineinherited

Creates a Boolean variable representing the status of the constraint (false = constraint is violated, true = constraint is satisfied).

It returns nullptr if the constraint does not support this API.

Definition at line 84 of file gen/java/com/google/ortools/constraintsolver/Constraint.java.


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