IBM ILOG Solver Debugger User's Manual > IlcSchedulerDebugger

IlcSchedulerDebugger

Description

The class IlcSchedulerDebugger provides an interface to the IBM® ILOG® Solver Debugger in an ILOG Scheduler environment.

Include File

<ilsched/schedulerdebugger.h>

Synopsis

class IlcSchedulerDebugger: public IlcAddOnDebugger { 
public: 
  IlcSchedulerDebugger(IlcSolverDebugger debugger, 
                       IlcSchedule s,
                       IloBool traceAllActivities = IloTrue, 
                       IloBool traceAllResources  = IloTrue,
                       IloBool traceAllowed = IloTrue);
  IlcSchedulerTrace getSchedulerTrace() const; 
  void registerActivity(IloActivity activity,
                        IloBool toBrowse = IloTrue, 
                        IloBool toTrace = IloTrue,
                        IlcVisualizeOption displayDomain =
                                           IlcVisualizeDisabled); 
  void registerResource(IloResource resource,
                        IloBool toBrowse = IloTrue);
  void registerUnaryResourceArray(IloArray<IloUnaryResource>
                                           &resources,
                                  const char* name,
                                  IloBool toBrowse = IloTrue);
  void setHorizon(IlcInt horizon); 
 };

Constructor


IlcSchedulerDebugger(IlcSolverDebugger debugger,

                       IlcSchedule s,

                       IloBool traceAllActivities = IloTrue, 

                       IloBool traceAllResources  = IloTrue,

                       IloBool traceAllowed = IloTrue);

The parameter s sets the IlcSchedule you have created to declare your activities and resources. If the parameter traceAllActivities is true and traceAllowed is also true, all activities are traced. If the parameter traceAllResources is true and traceAllowed is also true, all resources are traced. If the parameter traceAllowed is true, a specific trace for a Scheduler application is added.

Member Functions


IlcSchedulerTrace getSchedulerTrace() const;

Returns the graphical Scheduler trace added by the instance IlcSchedulerDebugger.


void registerActivity(IloActivity activity,

            IloBool toBrowse = IloTrue,

            IloBool toTrace = IloTrue,

             IlcVisualizeOption displayDomain = IlcVisualizeDisabled);

Registers an interest in an activity. The parameter activity sets the IlcActivity to consider. If the parameter toBrowse is true, the model will display the activity in the Debugger Model Browser. If the parameter toTrace is true, the activity must be traced and the start and end variables must be taken into account in the Christmas Tree. If the parameter displayDomain is true, the activity will be monitored graphically in the Activity Domains panel.


void registerResource(IloResource resource,

                        IloBool toBrowse = IloTrue);

Registers an interest in a resource. The parameter resource indicates the IloResource to consider. If the parameter toBrowse is true, the option Browse Active Model will be activated in the Debugger Model Browser.


void registerUnaryResourceArray(IloArray<IloUnaryResource>&resources,

                             const char* name,

                             IloBool toBrowse = IloTrue);

Registers an interest in a unary resource array. The parameter resources indicates the array of unary resources to consider. The parameter name indicates the name of the array to be displayed in the browser. If the parameter toBrowse is true, the option Browse Active Model will be activated in the Debugger Model Browser.


void setHorizon(IlcInt horizon);

Gives the horizon to consider in the graphical representation of the Activity Domains. This member function is to be called after registering the activities. The parameter horizon sets the maximum value of the upper bounds of all activity end variables.