IBM ILOG Solver Debugger User's Manual > IlcDebugger

IlcDebugger

Description

The class IlcDebugger is a handle class on an instance of the implementation class IlcDebuggerI. This class manages the debugging protocol with the Debugger GUI so that an external application or a specific engine can connect to the GUI.

Include File

<ilsolver/debugger.h>

Synopsis

class IlcDebugger {
public:
     IlcDebugger(IlcDebuggerI* impl = 0);
     int beginNestedSearchTreeView();
     void breakExecution();
     void browseAll();
     void close();
     IloBool displayResult() const;
     int endNestedSearchTreeView();
     IlcDebuggerI* getImpl() const {return _impl;}
     IloBool isActive() const;
     IloBool isAutomaticBrowse() const;
     IloBool isAutomaticDisplay() const;
     IloBool isConnected() const;
     IloBool isTextual() const;
     int newSearchTreeView();
     void sendConsole(const char* text);
     void sendSolution(const char* text);
     void setAutomaticBrowse(IloBool automaticBrowse);
     void setAutomaticDisplay(IloBool automatic);
 };

Constructor


IlcDebugger(IlcDebuggerI* impl = 0);

Creates a new handle class on the same implementation object.

Member Functions


int beginNestedSearchTreeView();

Creates a new Search Tree view in Solver Debugger. Sends notification of the next node created to the new Search Tree. Goes back to the previous Search Tree whenever endNestedSearch is called.


void breakExecution();

Interrupts the execution.


void browseAll();

Forces the Debugger to browse the model.


void close();

Closes the connection between the user application and the GUI server and releases the memory.


IloBool displayResult() const;

Displays the result graphically. In the current implementation, by default, this member function is automatically called at each solution. In Scheduler applications it displays a Gantt chart with precedences.


int endNestedSearchTreeView();

Goes back to the parent Search Tree. Considers the current Search Tree as terminated. Returns the identification of the parent Search Tree.


IlcDebuggerI* getImpl() const;

Returns the underlying implementation object.


IloBool isActive() const;

Returns true if the Debugger was set to active upon creation.


IloBool isAutomaticBrowse() const;

Returns true if the Debugger is in automatic browse mode.


IloBool isAutomaticDisplay() const;

Returns true if the Debugger is set to the automatic display mode for the result.


IloBool isConnected() const;

Returns true if the connection with the GUI server is still active.


IloBool isTextual() const;

Returns true if the Debugger was set to textual upon creation.


int newSearchTreeView();

Creates a new Search Tree view in Solver Debugger. Sends notification of the next node created to the new Search Tree. Considers the previous Search Tree as terminated. Returns the identification of the Search Tree view to be created.


void sendConsole(const char* text);

Sends a message to the Debugger Console Notebook Page.


void sendSolution(const char* text);

Sends a message to the Debugger Notebook Page.


void setAutomaticBrowse(IloBool automaticBrowse);

Tells the Debugger to switch on or off the automatic model browsing.


void setAutomaticDisplay(IloBool automatic);

Tells the Debugger to switch on or off the automatic display mode for the result. If the Debugger is set to the automatic display mode, add-on debuggers display a specific graphic representation of the solution, such as a Gantt chart for the Scheduler Debugger.