Gecode::Gist::Gist Class Reference
Functionality by programming task » Programming models » Gist: the Gecode Interactive Search Tool

Gecode Interactive Search Tool More...

`#include <qtgist.hh>`

## Signals

void | statusChanged (const Statistics &, bool)
| Signals that the tree has changed.
void | solution (const Space *)
| Signals that a solution has been found.
void | searchFinished (void)
| Signals that Gist is ready to be closed.

## Public Member Functions

| Gist (Space *root, bool bab, QWidget *parent, const Options &opt)
| Constructor.
| ~Gist (void)
| Destructor.
void | addDoubleClickInspector (Inspector *i0)
| Add double click inspector i0.
void | addSolutionInspector (Inspector *i0)
| Add solution inspector i0.
void | addMoveInspector (Inspector *i0)
| Add move inspector i0.
void | addComparator (Comparator *c0)
| Add comparator c0.
void | setAutoHideFailed (bool b)
| Set preference whether to automatically hide failed subtrees.
void | setAutoZoom (bool b)
| Set preference whether to automatically zoom to fit.
bool | getAutoHideFailed (void)
| Return preference whether to automatically hide failed subtrees.
bool | getAutoZoom (void)
| Return preference whether to automatically zoom to fit.
void | setShowCopies (bool b)
| Set preference whether to show copies in the tree.
bool | getShowCopies (void)
| Return preference whether to show copies in the tree.
void | setRefresh (int i)
| Set refresh rate.
void | setRefreshPause (int i)
| Set refresh pause in msec.
bool | getSmoothScrollAndZoom (void)
| Return preference whether to use smooth scrolling and zooming.
void | setSmoothScrollAndZoom (bool b)
| Set preference whether to use smooth scrolling and zooming.
bool | getMoveDuringSearch (void)
| Return preference whether to move cursor during search.
void | setMoveDuringSearch (bool b)
| Set preference whether to move cursor during search.
void | setRecompDistances (int c_d, int a_d)
| Set recomputation parameters c_d and a_d.
int | getCd (void)
| Return recomputation distance.
int | getAd (void)
| Return adaptive recomputation distance.
bool | finish (void)
| Stop search and wait until finished.
void | resizeEvent (QResizeEvent *)
| Handle resize event.

## Public Attributes

QAction * | inspect
| Inspect current node.
QAction * | inspectBeforeFP
| Inspect current node before fixpoint.
QAction * | stop
| Stop search.
QAction * | reset
| Reset Gist.
QAction * | navUp
| Navigate to parent node.
QAction * | navDown
| Navigate to leftmost child node.
QAction * | navLeft
| Navigate to left sibling.
QAction * | navRight
| Navigate to right sibling.
QAction * | navRoot
| Navigate to root node.
QAction * | navNextSol
| Navigate to next solution (to the left).
QAction * | navPrevSol
| Navigate to previous solution (to the right).
QAction * | searchNext
| Search next solution in current subtree.
QAction * | searchAll
| Search all solutions in current subtree.
QAction * | toggleHidden
| Toggle whether current node is hidden.
QAction * | hideFailed
| Hide failed subtrees under current node.
QAction * | unhideAll
| Unhide all hidden subtrees under current node.
QAction * | labelBranches
| Label branches under current node.
QAction * | labelPath
| Label branches on path to root.
QAction * | zoomToFit
| Zoom tree to fit window.
QAction * | center
| Center on current node.
QAction * | exportPDF
| Export PDF of current subtree.
QAction * | exportWholeTreePDF
| Export PDF of whole tree.
QAction * | print
| Print tree.
QAction * | bookmarkNode
| Bookmark current node.
QAction * | compareNode
| Compare current node to other node.
QAction * | compareNodeBeforeFP
| Compare current node to other node before fixpoint.
QAction * | setPath
| Set path from current node to the root.
QAction * | inspectPath
| Inspect all nodes on selected path.
QAction * | showNodeStats
| Open node statistics inspector.
QAction * | toggleStop
| Bookmark current node.
QAction * | unstopAll
| Bookmark current node.
QActionGroup * | solutionInspectorGroup
| Group of all actions for solution inspectors.
QActionGroup * | doubleClickInspectorGroup
| Group of all actions for double click inspectors.
QActionGroup * | moveInspectorGroup
| Group of all actions for move inspectors.
QActionGroup * | comparatorGroup
| Group of all actions for comparators.
QActionGroup * | bookmarksGroup
| Group of all actions for bookmarks.
QActionGroup * | inspectGroup
| Group of all actions for direct inspector selection.
QActionGroup * | inspectBeforeFPGroup
| Group of all actions for direct inspector selection.

## Protected Member Functions

void | addInspector (Inspector *i, QAction *&nas, QAction *&nad, QAction *&nam)
| Add inspector i0.

## Detailed Description

Gecode Interactive Search Tool

This class provides an interactive search tree viewer and explorer as a Qt widget. You can embedd or inherit from this widget to use Gist in your own project.

Definition at line 81 of file qtgist.hh.

## Constructor & Destructor Documentation

## Gist()

Gecode::Gist::Gist::Gist | ( | Space * | root,
|  | bool | bab,
|  | QWidget * | parent,
|  | const Options & | opt )

Constructor.

Definition at line 42 of file qtgist.cpp.

## ~Gist()

Gecode::Gist::Gist::~Gist | ( | void |  | ) |

Destructor.

Definition at line 549 of file qtgist.cpp.

## Member Function Documentation

## addDoubleClickInspector()

void Gecode::Gist::Gist::addDoubleClickInspector | ( | Inspector * | i0 | ) |

Add double click inspector i0.

Definition at line 492 of file qtgist.cpp.

## addSolutionInspector()

void Gecode::Gist::Gist::addSolutionInspector | ( | Inspector * | i0 | ) |

Add solution inspector i0.

Definition at line 474 of file qtgist.cpp.

## addMoveInspector()

void Gecode::Gist::Gist::addMoveInspector | ( | Inspector * | i0 | ) |

Add move inspector i0.

Definition at line 510 of file qtgist.cpp.

## addComparator()

void Gecode::Gist::Gist::addComparator | ( | Comparator * | c0 | ) |

Add comparator c0.

Definition at line 528 of file qtgist.cpp.

## setAutoHideFailed()

void Gecode::Gist::Gist::setAutoHideFailed | ( | bool | b | ) |

Set preference whether to automatically hide failed subtrees.

Definition at line 774 of file qtgist.cpp.

## setAutoZoom()

void Gecode::Gist::Gist::setAutoZoom | ( | bool | b | ) |

Set preference whether to automatically zoom to fit.

Definition at line 776 of file qtgist.cpp.

## getAutoHideFailed()

bool Gecode::Gist::Gist::getAutoHideFailed | ( | void |  | ) |

Return preference whether to automatically hide failed subtrees.

Definition at line 778 of file qtgist.cpp.

## getAutoZoom()

bool Gecode::Gist::Gist::getAutoZoom | ( | void |  | ) |

Return preference whether to automatically zoom to fit.

Definition at line 780 of file qtgist.cpp.

## setShowCopies()

void Gecode::Gist::Gist::setShowCopies | ( | bool | b | ) |

Set preference whether to show copies in the tree.

Definition at line 816 of file qtgist.cpp.

## getShowCopies()

bool Gecode::Gist::Gist::getShowCopies | ( | void |  | ) |

Return preference whether to show copies in the tree.

Definition at line 820 of file qtgist.cpp.

## setRefresh()

void Gecode::Gist::Gist::setRefresh | ( | int | i | ) |

Set refresh rate.

Definition at line 782 of file qtgist.cpp.

## setRefreshPause()

void Gecode::Gist::Gist::setRefreshPause | ( | int | i | ) |

Set refresh pause in msec.

Definition at line 784 of file qtgist.cpp.

## getSmoothScrollAndZoom()

bool Gecode::Gist::Gist::getSmoothScrollAndZoom | ( | void |  | ) |

Return preference whether to use smooth scrolling and zooming.

Definition at line 786 of file qtgist.cpp.

## setSmoothScrollAndZoom()

void Gecode::Gist::Gist::setSmoothScrollAndZoom | ( | bool | b | ) |

Set preference whether to use smooth scrolling and zooming.

Definition at line 790 of file qtgist.cpp.

## getMoveDuringSearch()

bool Gecode::Gist::Gist::getMoveDuringSearch | ( | void |  | ) |

Return preference whether to move cursor during search.

Definition at line 794 of file qtgist.cpp.

## setMoveDuringSearch()

void Gecode::Gist::Gist::setMoveDuringSearch | ( | bool | b | ) |

Set preference whether to move cursor during search.

Definition at line 798 of file qtgist.cpp.

## setRecompDistances()

void Gecode::Gist::Gist::setRecompDistances | ( | int | c_d,
|  | int | a_d )

Set recomputation parameters c_d and a_d.

Definition at line 802 of file qtgist.cpp.

## getCd()

int Gecode::Gist::Gist::getCd | ( | void |  | ) |

Return recomputation distance.

Definition at line 807 of file qtgist.cpp.

## getAd()

int Gecode::Gist::Gist::getAd | ( | void |  | ) |

Return adaptive recomputation distance.

Definition at line 811 of file qtgist.cpp.

## finish()

bool Gecode::Gist::Gist::finish | ( | void |  | ) |

Stop search and wait until finished.

Definition at line 699 of file qtgist.cpp.

## resizeEvent()

void Gecode::Gist::Gist::resizeEvent | ( | QResizeEvent * |  | ) |

Handle resize event.

Definition at line 423 of file qtgist.cpp.

## statusChanged

void Gecode::Gist::Gist::statusChanged | ( | const Statistics & | ,
|  | bool | )

signal

Signals that the tree has changed.

## solution

void Gecode::Gist::Gist::solution | ( | const Space * |  | ) |

signal

Signals that a solution has been found.

## searchFinished

void Gecode::Gist::Gist::searchFinished | ( | void |  | ) |

signal

Signals that Gist is ready to be closed.

## addInspector()

void Gecode::Gist::Gist::addInspector | ( | Inspector * | i,
|  | QAction *& | nas,
|  | QAction *& | nad,
|  | QAction *& | nam )

protected

Add inspector i0.

Definition at line 428 of file qtgist.cpp.

## Member Data Documentation

## inspect

QAction* Gecode::Gist::Gist::inspect

Inspect current node.

Definition at line 118 of file qtgist.hh.

## inspectBeforeFP

QAction* Gecode::Gist::Gist::inspectBeforeFP

Inspect current node before fixpoint.

Definition at line 120 of file qtgist.hh.

## stop

QAction* Gecode::Gist::Gist::stop

Stop search.

Definition at line 122 of file qtgist.hh.

## reset

QAction* Gecode::Gist::Gist::reset

Reset Gist.

Definition at line 124 of file qtgist.hh.

## navUp

QAction* Gecode::Gist::Gist::navUp

Navigate to parent node.

Definition at line 126 of file qtgist.hh.

## navDown

QAction* Gecode::Gist::Gist::navDown

Navigate to leftmost child node.

Definition at line 128 of file qtgist.hh.

## navLeft

QAction* Gecode::Gist::Gist::navLeft

Navigate to left sibling.

Definition at line 130 of file qtgist.hh.

## navRight

QAction* Gecode::Gist::Gist::navRight

Navigate to right sibling.

Definition at line 132 of file qtgist.hh.

## navRoot

QAction* Gecode::Gist::Gist::navRoot

Navigate to root node.

Definition at line 134 of file qtgist.hh.

## navNextSol

QAction* Gecode::Gist::Gist::navNextSol

Navigate to next solution (to the left).

Definition at line 136 of file qtgist.hh.

## navPrevSol

QAction* Gecode::Gist::Gist::navPrevSol

Navigate to previous solution (to the right).

Definition at line 138 of file qtgist.hh.

## searchNext

QAction* Gecode::Gist::Gist::searchNext

Search next solution in current subtree.

Definition at line 140 of file qtgist.hh.

## searchAll

QAction* Gecode::Gist::Gist::searchAll

Search all solutions in current subtree.

Definition at line 142 of file qtgist.hh.

## toggleHidden

QAction* Gecode::Gist::Gist::toggleHidden

Toggle whether current node is hidden.

Definition at line 144 of file qtgist.hh.

## hideFailed

QAction* Gecode::Gist::Gist::hideFailed

Hide failed subtrees under current node.

Definition at line 146 of file qtgist.hh.

## unhideAll

QAction* Gecode::Gist::Gist::unhideAll

Unhide all hidden subtrees under current node.

Definition at line 148 of file qtgist.hh.

## labelBranches

QAction* Gecode::Gist::Gist::labelBranches

Label branches under current node.

Definition at line 150 of file qtgist.hh.

## labelPath

QAction* Gecode::Gist::Gist::labelPath

Label branches on path to root.

Definition at line 152 of file qtgist.hh.

## zoomToFit

QAction* Gecode::Gist::Gist::zoomToFit

Zoom tree to fit window.

Definition at line 154 of file qtgist.hh.

## center

QAction* Gecode::Gist::Gist::center

Center on current node.

Definition at line 156 of file qtgist.hh.

## exportPDF

QAction* Gecode::Gist::Gist::exportPDF

Export PDF of current subtree.

Definition at line 158 of file qtgist.hh.

## exportWholeTreePDF

QAction* Gecode::Gist::Gist::exportWholeTreePDF

Export PDF of whole tree.

Definition at line 160 of file qtgist.hh.

## print

QAction* Gecode::Gist::Gist::print

Print tree.

Definition at line 162 of file qtgist.hh.

## bookmarkNode

QAction* Gecode::Gist::Gist::bookmarkNode

Bookmark current node.

Definition at line 165 of file qtgist.hh.

## compareNode

QAction* Gecode::Gist::Gist::compareNode

Compare current node to other node.

Definition at line 167 of file qtgist.hh.

## compareNodeBeforeFP

QAction* Gecode::Gist::Gist::compareNodeBeforeFP

Compare current node to other node before fixpoint.

Definition at line 169 of file qtgist.hh.

## setPath

QAction* Gecode::Gist::Gist::setPath

Set path from current node to the root.

Definition at line 171 of file qtgist.hh.

## inspectPath

QAction* Gecode::Gist::Gist::inspectPath

Inspect all nodes on selected path.

Definition at line 173 of file qtgist.hh.

## showNodeStats

QAction* Gecode::Gist::Gist::showNodeStats

Open node statistics inspector.

Definition at line 175 of file qtgist.hh.

## toggleStop

QAction* Gecode::Gist::Gist::toggleStop

Bookmark current node.

Definition at line 177 of file qtgist.hh.

## unstopAll

QAction* Gecode::Gist::Gist::unstopAll

Bookmark current node.

Definition at line 179 of file qtgist.hh.

## solutionInspectorGroup

QActionGroup* Gecode::Gist::Gist::solutionInspectorGroup

Group of all actions for solution inspectors.

Definition at line 182 of file qtgist.hh.

## doubleClickInspectorGroup

QActionGroup* Gecode::Gist::Gist::doubleClickInspectorGroup

Group of all actions for double click inspectors.

Definition at line 184 of file qtgist.hh.

## moveInspectorGroup

QActionGroup* Gecode::Gist::Gist::moveInspectorGroup

Group of all actions for move inspectors.

Definition at line 186 of file qtgist.hh.

## comparatorGroup

QActionGroup* Gecode::Gist::Gist::comparatorGroup

Group of all actions for comparators.

Definition at line 188 of file qtgist.hh.

## bookmarksGroup

QActionGroup* Gecode::Gist::Gist::bookmarksGroup

Group of all actions for bookmarks.

Definition at line 190 of file qtgist.hh.

## inspectGroup

QActionGroup* Gecode::Gist::Gist::inspectGroup

Group of all actions for direct inspector selection.

Definition at line 192 of file qtgist.hh.

## inspectBeforeFPGroup

QActionGroup* Gecode::Gist::Gist::inspectBeforeFPGroup

Group of all actions for direct inspector selection.

Definition at line 194 of file qtgist.hh.

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

- gecode/gist/qtgist.hh
- gecode/gist/qtgist.cpp