GraphTool Documentation - Developer Guide

This guide is meant to complement the Doxygen and code comments provided and provide more input as to how to the tool was developed and the design considerations made.

You can use this as a guide to developing various sections of the software.

  1. Introduction to the Internal Data Structures
  2. Using the Grapher class
  3. Working with Graph Filters
  4. Creating Difference Views
  5. Developing the QT UI
  6. Testing with Google Test
  7. Compiling the software/Makefile
  8. Compiling the documentation/mkdocs
  9. Introduction to Markdown

Known Issues

These are known issues with regards to the development of the application.

  1. Name is treated as primary key across the interface. If this assumption does not hold, a primary key system would need to be implemented, giving each SWU,Module etc. a unique ID and re-implementing the list comparators CompareModuleBy... to use this primary key. Also the UI would be required to use the primary key instead of node_text() to make the link between which nodes in the Grapher match to what UI components in the GraphView.

  2. FilterModel in the UI ought to be refactored to be a proper Model and not just a selection of static methods.

  3. MainController ought to be split in two, GraphModel

Back