From f6eb8241261ed6a79abc3c73ada5a94349239141 Mon Sep 17 00:00:00 2001 From: caballero Date: Fri, 6 Mar 2009 15:03:46 +0000 Subject: [PATCH] Added files to the doxygen documentation --- src2/doxygen/Architecture.htm | 348 ++++++++++++++++++++++++++++++ src2/doxygen/ClassDiagram.htm | 22 ++ src2/doxygen/ComponentDiagram.htm | 22 ++ src2/doxygen/DoxyMainPage.txt.in | 37 ++-- src2/doxygen/SeqAddDir.htm | 22 ++ src2/doxygen/SeqAddFile.htm | 22 ++ src2/doxygen/SeqCreateDB.htm | 22 ++ src2/doxygen/SeqGetImages.htm | 22 ++ src2/doxygen/SeqRemove.htm | 22 ++ src2/doxygen/SeqSelChanged.htm | 22 ++ 10 files changed, 549 insertions(+), 12 deletions(-) create mode 100644 src2/doxygen/Architecture.htm create mode 100644 src2/doxygen/ClassDiagram.htm create mode 100644 src2/doxygen/ComponentDiagram.htm create mode 100644 src2/doxygen/SeqAddDir.htm create mode 100644 src2/doxygen/SeqAddFile.htm create mode 100644 src2/doxygen/SeqCreateDB.htm create mode 100644 src2/doxygen/SeqGetImages.htm create mode 100644 src2/doxygen/SeqRemove.htm create mode 100644 src2/doxygen/SeqSelChanged.htm diff --git a/src2/doxygen/Architecture.htm b/src2/doxygen/Architecture.htm new file mode 100644 index 0000000..3d1fd07 --- /dev/null +++ b/src2/doxygen/Architecture.htm @@ -0,0 +1,348 @@ +ï»¿ + + + + + +Architecture + + + + +

Architecture

+ +

Generalities

+ +

cvs : creatis/creaImageIO +
- +
  cvs co -D + :PROTOCOL:USERNAME@cvs.creatis.insa-lyon.fr:/cvs/creatis creaImageIO +
  +
+
09/02/09 : +
- new sources in src2 : create a lib called creaImageIO2 +
- command line app : appli/gimmick +
- cmake option : BUILD_V2 to build the new version +
+
All C++ files begin with creaImageIO +
All creaImageIO classes are in a namespace creaImageIO + +

General stucture

+ + +

The main data structure : attributed tree + +
- all related files are of the form : creaImageIOTree +
- all related classes are in a namespace : creaImageIO::tree +
+
+
The abstract 'Model' : TreeHandler + = manages a data source (read-only; read/write) +
+
- +
  Concrete models : now SQLiteTreeHandler; future + IRodsTreeHandler, FavoritesTreeHandler? +
  +
+
+
The controller 'Gimmick' : controls different + TreeHandlers: +
+
- Local database handler +
- Favorites handler
- Other which are open on user demand +
+
The Views: +
- +
  Abstract GimmickView : + Dialog
  +
- +
  Concrete GimmickView : now + WxGimmickView; future QGimmickView ? +
  +
- +
  Do we need to have abstract classes for + GimmickView components ? +
  +
  - +
    TreeView : is + associated with a TreeHandler to + visualize its Tree
    +
  - +
    AttributeView : + visualizes a set of attributes (only one for a + GimmickView) +
    +
  - +
    ImageView : preview of + images + +
    +
  +
+

Classes

+ + +

Data structure: +Attributed tree

+ + +

in namespace creaImageIO::tree + +

Tree +
- Attributed tree structure +
- inherits Node
- +
  holds a vector of root + TreeNode
  +
+
+
TreeData +
+
- Abstract class to store user data on a tree +
+
Node +
- belong to a Tree,
- holds a pointer on parent Node, +
- holds a vector of children Node +
+
+
NodeData +
+
- Abstract class to store user data on a tree node +
+
Descriptor +
- Descriptor of the structure a tree (number of levels, descriptors of + each level, ...)
- +
  holds a vector of + LevelDescriptor
  +
+
+
LevelDescriptor +
+
- +
  holds a vector of + TreeAttributeDescriptor +
  +
+
+
AttributeDescriptor +
+
- stores name, dicom group/elem, flags +
+
Comparator +
- Abstract definition of a comparator of Node +
- +
  Comparison is done by operator()(Node* const &, Node* + const &)
  +
+
+
ComparatorWithOrder +
+
- Abstract Comparator whose order can be reversed +
- +
  Concrete comparison is done by method compare(Node* + const &, Node* const &)
  +
+
+
LexicographicalComparator +
+
- A Comparator which stores a vector of Comparators and which performs + lexicographical comparison +
+
+
IntComparator : Compares the + values of a given Attribute of the Nodes which is decoded as an int value +
+
+
FloatComparator : Compares the + values of a given Attribute of the Nodes which is decoded as a float value +
+
+
StringComparator : Compares + the values of a given Attribute of the Nodes which is decoded as a string + value + +
+

Models : TreeHandler and +descendants

+ + +

+
TreeHandler : Abstract class + which 'handles' a Tree structure. +
+
- Can: + Load the children of a given + Node +
+
+
SQLiteTreeHandler : Concrete + TreeHandler which manages a tree stored in a sqlite database +
+
CppSQLite3.h / CppSQLite3.cpp : C++ interface to sqlite db +

... +

+
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) + +
+

Image handling

+ + +

creaImageIOImageReader.h/cpp : +
- +
  SpecificImageReader +
  +
- +
  ImageReader +
  +
+
creaImageIOMultiThreadImageReader.h/cpp +
creaImageIOIndexedHeap.h/txx +

Controller

+ + +

Gimmick +

Views

+ + +

+
GimmickView : Abstract +
+
+
WxGimmickView +
+
- +
  WxTreeView
  +
- +
  WxAttributeView +
  +
- +
  WxImageView +
  +
+
QGimmickView +
- ...
+

+ + + + diff --git a/src2/doxygen/ClassDiagram.htm b/src2/doxygen/ClassDiagram.htm new file mode 100644 index 0000000..e8f683e --- /dev/null +++ b/src2/doxygen/ClassDiagram.htm @@ -0,0 +1,22 @@ +ï»¿ + + + + + +Class Diagram + + + + + +

Class Diagram

+ + + + diff --git a/src2/doxygen/ComponentDiagram.htm b/src2/doxygen/ComponentDiagram.htm new file mode 100644 index 0000000..11620e8 --- /dev/null +++ b/src2/doxygen/ComponentDiagram.htm @@ -0,0 +1,22 @@ +ï»¿ + + + + + +Class Diagram + + + + + +

Component Diagram

+ + + + diff --git a/src2/doxygen/DoxyMainPage.txt.in b/src2/doxygen/DoxyMainPage.txt.in index 244ca8e..652e92b 100644 --- a/src2/doxygen/DoxyMainPage.txt.in +++ b/src2/doxygen/DoxyMainPage.txt.in @@ -1,26 +1,39 @@ -//** +/** * \mainpage creaImageIO documentation \htmlonly -

Diagrams of the architecture (v2)

Architecture Description (v2)

- Class Diagram + Architecture
- Component Diagram -

Sequence Diagrams (v2)

Diagrams of the architecture

- On "Add Files" to a database + Class Diagram
- On "Add Directories" to a database + Component Diagram
- On "Remove Files2 from database + +

Sequence Diagrams

- On "Create a database" + On "Add Files" to a database
- On "Selection has changed" + On "Add Directories" to a database +
+ On "Remove Files" from database +
+ On "Create a database" +
+ On "Selection has changed" +
+ On "Get Selected Images as VTK structures"
- On "Get Selected Images as VTK structures" - \endhtmlonly + + + + + + + */ \ No newline at end of file diff --git a/src2/doxygen/SeqAddDir.htm b/src2/doxygen/SeqAddDir.htm new file mode 100644 index 0000000..d094eff --- /dev/null +++ b/src2/doxygen/SeqAddDir.htm @@ -0,0 +1,22 @@ +ï»¿ + + + + + +Class Diagram + + + + + +

Adding a Directory

+ + + + diff --git a/src2/doxygen/SeqAddFile.htm b/src2/doxygen/SeqAddFile.htm new file mode 100644 index 0000000..45d7da1 --- /dev/null +++ b/src2/doxygen/SeqAddFile.htm @@ -0,0 +1,22 @@ +ï»¿ + + + + + +Class Diagram + + + + + +

Adding a File

+ + + + diff --git a/src2/doxygen/SeqCreateDB.htm b/src2/doxygen/SeqCreateDB.htm new file mode 100644 index 0000000..2424392 --- /dev/null +++ b/src2/doxygen/SeqCreateDB.htm @@ -0,0 +1,22 @@ +ï»¿ + + + + + +Class Diagram + + + + + +

Creating a Database

+ + + + diff --git a/src2/doxygen/SeqGetImages.htm b/src2/doxygen/SeqGetImages.htm new file mode 100644 index 0000000..0495671 --- /dev/null +++ b/src2/doxygen/SeqGetImages.htm @@ -0,0 +1,22 @@ +ï»¿ + + + + + +Class Diagram + + + + + +

On Get Images

+ + + + diff --git a/src2/doxygen/SeqRemove.htm b/src2/doxygen/SeqRemove.htm new file mode 100644 index 0000000..e8fd222 --- /dev/null +++ b/src2/doxygen/SeqRemove.htm @@ -0,0 +1,22 @@ +ï»¿ + + + + + +Class Diagram + + + + + +

Remove a file

+ + + + diff --git a/src2/doxygen/SeqSelChanged.htm b/src2/doxygen/SeqSelChanged.htm new file mode 100644 index 0000000..d3fc8f3 --- /dev/null +++ b/src2/doxygen/SeqSelChanged.htm @@ -0,0 +1,22 @@ +ï»¿ + + + + + +Class Diagram + + + + + +

On Selection Changed

+ + + + -- 2.45.2