src/creaImageIOTree.h

   1 /*
   2 # ---------------------------------------------------------------------
   3 #
   4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5 #                        pour la Santé)
   6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   9 #
  10 #  This software is governed by the CeCILL-B license under French law and
  11 #  abiding by the rules of distribution of free software. You can  use,
  12 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  13 #  license as circulated by CEA, CNRS and INRIA at the following URL
  14 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  15 #  or in the file LICENSE.txt.
  16 #
  17 #  As a counterpart to the access to the source code and  rights to copy,
  18 #  modify and redistribute granted by the license, users are provided only
  19 #  with a limited warranty  and the software's author,  the holder of the
  20 #  economic rights,  and the successive licensors  have only  limited
  21 #  liability.
  22 #
  23 #  The fact that you are presently reading this means that you have had
  24 #  knowledge of the CeCILL-B license and that you accept its terms.
  25 # ------------------------------------------------------------------------
  26 */
  27
  28 #ifndef __creaImageIOTree_h_INCLUDED__
  29 #define __creaImageIOTree_h_INCLUDED__
  30
  31 #include <creaImageIOTreeNode.h>
  32
  33 namespace creaImageIO
  34 {
  35
  36   namespace tree
  37   {
  38     /**
  39      * \ingroup Tree
  40      */
  41     //=====================================================================
  42     /// Abstract class to store user data on a Tree
  43     struct TreeData
  44     {
  45       TreeData() {}
  46       virtual ~TreeData() {}
  47     };
  48     //=====================================================================
  49
  50     //=====================================================================
  51     /// An attributed Tree structure
  52     /** \ingroup Tree
  53      */
  54     class Tree : public Node
  55     {
  56     public:
  57       /// Ctor
  58       Tree();
  59       /// Virtual destructor
  60       virtual ~Tree();
  61
  62       /// Returns the descriptor of the tree
  63
  64       /// Returns the tree to which the node belongs
  65       virtual Tree* GetTree() { return this; }
  66       /// Returns the tree to which the node belongs
  67       virtual const Tree* GetTree() const { return this; }
  68       /// Returns the level of the node in the tree
  69       virtual int GetLevel() const { return 0; }
  70
  71       /// Returns the Descriptor of the tree (const)
  72       const Descriptor& GetDescriptor() const { return mDescriptor; }
  73       /// Returns the descriptor of the tree
  74       Descriptor& GetDescriptor() { return mDescriptor; }
  75
  76      /// Returns the number of levels of the tree
  77       unsigned int GetNumberOfLevels()
  78       { return GetDescriptor().GetNumberOfLevels(); }
  79
  80       /// Returns the LevelDescriptor of a given level (const ref)
  81       const LevelDescriptor& GetLevelDescriptor(int level) const
  82       { return GetDescriptor().GetLevelDescriptor(level); }
  83
  84       /// Returns the AttributeDescriptorList of a given level (const ref)
  85           /// type = 0 all attributes
  86           /// type = 1 without ID and PATIENT_ID
  87       const LevelDescriptor::AttributeDescriptorListType&
  88       GetAttributeDescriptorList(int level, int type = 0) const
  89       { return GetDescriptor().GetAttributeDescriptorList(level, type); }
  90
  91       virtual void Print() const;
  92
  93
  94           /// Copy descriptor list without ID tag
  95           void CopyAttributeDescriptorList(int level)
  96           {
  97                   GetDescriptor().CopyAttributeDescriptorList(level);
  98           }
  99
 100           /// Test if this attribute is available in this tree description
 101           const std::string isAttributeExist(const std::string i_attr)
 102           {
 103                   return mDescriptor.isExist(i_attr);
 104           }
 105
 106     private:
 107       Descriptor mDescriptor;
 108
 109     };
 110     // EO class Tree
 111     //=====================================================================
 112
 113   } // EO namespace tree
 114
 115 } // EO namespace creaImageIO
 116
 117 // EOF
 118 #endif