src/README.txt

   1 New architecture created on 04/02/09 following a MVC approach
   2
   3 Elements of the architecture:
   4
   5 * Data structure: Attributed tree
   6 --------------------------------------
   7 in namespace creaImageIO::tree
   8 Tree :   Attributed tree structure
   9          inherits Node
  10          holds a vector of root TreeNode
  11 TreeData : Abstract class to store user data on a tree
  12 Node :
  13          belong to a Tree,
  14          holds a pointer on parent Node,
  15          holds a vector of children Node
  16 NodeData : Abstract class to store user data on a tree node
  17 Descriptor : Descriptor of the structure a tree (number of levels, descriptors of each level, ...)
  18
  19          holds a vector of LevelDescriptor
  20 LevelDescriptor :
  21          holds a vector of TreeAttributeDescriptor
  22 AttributeDescriptor :
  23          stores name, dicom group/elem, flags
  24 Comparator: Abstract definition of a comparator of Node
  25             Comparison is done by operator()(Node* const &, Node* const &)
  26 ComparatorWithOrder : Abstract Comparator whose order can be reversed
  27                     Concrete comparison is done by method compare(Node* const &, Node* const &)
  28 LexicographicalComparator :  A Comparator which stores a vector of Comparators and which performs lexicographical comparison
  29
  30 IntComparator    : Compares the values of a given Attribute of the Nodes which is decoded as an int    value
  31 FloatComparator  : Compares the values of a given Attribute of the Nodes which is decoded as a  float  value
  32 StringComparator : Compares the values of a given Attribute of the Nodes which is decoded as a  string value
  33
  34
  35 * Models : TreeHandler and descendants
  36 --------------------------------------
  37
  38 TreeHandler : Abstract class which 'handles' a Tree structure.
  39             Can:
  40             Load the children of a given Node
  41
  42 SQLiteTreeHandler : Concrete TreeHandler which manages a tree stored in a sqlite database
  43 CppSQLite3.h / CppSQLite3.cpp : C++ interface to sqlite db
  44 ...
  45
  46 ImageFinder : Parses (recursively) a part of a filesystem to look for known images and load their attributes in order to add the images to a Tree (submission via a TreeHandler::AddBranch)
  47
  48
  49 * Image handling
  50 ----------------
  51
  52 creaImageIOImageReader.h/cpp :
  53 SpecificImageReader
  54 ImageReader
  55
  56 creaImageIOMultiThreadImageReader.h/cpp
  57 creaImageIOIndexedHeap.h/cpp
  58
  59 * Views :
  60 ---------
  61 TreeView
  62 WxTreeView
  63 WxGimmickView
  64 QTreeView
  65 QGimmickView
  66 ...
  67
  68 * Controller :
  69 --------------
  70 Gimmick
  71 ...