Class IlcSchedulerTrace

The IlcSchedulerTrace class is used to determine which Scheduler objects (activities, resources, constraints) will be traced.

The implementation class, IlcSchedulerTraceI, has several virtual methods that can be overloaded to get different behaviors.

Example

 MySchedTraceI* traceI = new (solver.getHeap())
 	MySchedTraceI(schedule);
 IlcSchedulerTrace trace(traceI);
 trace.traceAllActivities();
 trace.traceAllResources();

This member function states that the time bound constraint must be traced: if this constraint has a variable date, modifications of this variable will trigger the call of specific member functions of the implementation class of the invoking object.

If the argument withActivity equals IlcTrue, then the activity involved in the time bound constraint will also be traced.

This member function states that the precedence constraint must be traced: if this precedence constraint has a variable delay, modifications of this variable will trigger the call of specific member functions of the implementation class of the invoking object.

If the argument withActivities equals IlcTrue, then the two activities involved in the precedence constraint will also be traced.

This member function states that the given alternative resource set must be traced; all the alternative resource constraints that refer to this set will be traced.

This member function states that the resource must be traced: this means that the structures used in the global constraints posted on this resource (timetables, precedence graphs) will be traced. Modifications of those data structures will trigger the call of specific member functions of the implementation class of the invoking object.

If the argument withResourceConstraints equals IlcTrue, then all the resource constraints in which this resource is involved, and their corresponding activities will also be traced.

This member function states that the given alternative resource constraint must be traced: any modification of any variable that this resource constraint owns (index of chosen resource, capacity, or required set) will call a specific member function of the implementation class of the invoking object.

If the argument withActivity equals IlcTrue, then the activity that corresponds to this alternative resource constraint will also be traced.

This member function states that the given resource constraint must be traced: any modification of any variable that this resource constraint owns (capacity or required set) will call a specific member function of the implementation class of the invoking object.

If the argument withActivity equals IlcTrue, then the activity that corresponds to this resource constraint will also be traced.

This member function states that the given activity must be traced: any modification of any variable that this activity owns will call a specific member function of the implementation class of the invoking object.

If the argument withResourceConstraints equals IlcTrue, then all the resource constraints, alternative resource constraints, precedence constraints and time bound constraints in which this activity is involved will also be traced.

This member function states that all the activities must be traced. The constraints in which they are involved (time bound, precedence, resource, and alternative resource constraints) will also be traced.

This member function states that all the failures must be traced. The corresponding member functions of the implementation class of the invoking object will be called. The default behavior of a Scheduler trace object (that is, if this method is not called), is that only failures triggered by Solver variables of traced Scheduler objects will be traced.

This member function states that all the resources must be traced. The constraints in which they are involved (resource constraints, alternative resource constraints), and their corresponding activities, will also be traced.

Note that temporal constraints will not be traced, and activities that do not require a resource will not be traced either. Use the member function IlcSchedulerTrace::traceAllActivities for such a case.