src/creaImageIOTreeDescriptor.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
  29 #ifndef __creaImageIOTreeDescriptor_h_INCLUDED__
  30 #define __creaImageIOTreeDescriptor_h_INCLUDED__
  31
  32 #include <creaImageIOTreeAttributeMapType.h>
  33 #include <creaImageIOTreeLevelDescriptor.h>
  34
  35
  36 namespace creaImageIO
  37 {
  38         using namespace std;
  39   namespace tree
  40   {
  41
  42     /**
  43      * \ingroup Tree
  44      */
  45
  46         ///Descriptor of the structure of a Tree (number of levels, descriptors of each level, ...).
  47           //Any Tree has at least one level (level 0) of name "Root"
  48
  49     class Descriptor
  50     {
  51     public:
  52       /// Ctor : creates the mandatory level 0 descriptor called "Root"
  53       Descriptor();
  54       /// Destructor
  55       ~Descriptor();
  56
  57       /// Loads from a xml description file
  58       void LoadXML(const std::string& filename);
  59       /// Creates the default descriptor
  60       void CreateDefault();
  61
  62       /// Returns the number of levels of the tree
  63       unsigned int GetNumberOfLevels()
  64       { return (int)mLevelDescriptorList.size(); }
  65
  66       /// Returns the LevelDescriptor of a given level (const ref)
  67       const LevelDescriptor& GetLevelDescriptor(int level) const
  68       { return mLevelDescriptorList[level]; }
  69
  70       /// Returns the AttributeDescriptorList of a given level (const ref)
  71             /// type = 0 all attributes
  72           /// type = 1 without ID and PATIENT_ID
  73       const LevelDescriptor::AttributeDescriptorListType&
  74       GetAttributeDescriptorList(int level, int type = 0) const
  75       { return mLevelDescriptorList[level].GetAttributeDescriptorList(type); }
  76
  77
  78       /// Copy the AttributeDescriptorList without ID tag
  79           void CopyAttributeDescriptorList(int level)
  80           {
  81                   mLevelDescriptorList[level].CopyAttributeDescriptorList();
  82           }
  83
  84       /// Adds a LevelDescriptor at the end of the list
  85       void Add(const LevelDescriptor&);
  86
  87       /// Adds an AttributeDescriptor to level l
  88       void Add(const AttributeDescriptor&, int l);
  89
  90
  91       /// Builds the key to value map of all the attributes of the tree
  92         void BuildAttributeMap( AttributeMapType& ) const;
  93
  94       /// The type of LevelDescriptor container
  95         typedef std::vector<LevelDescriptor> LevelDescriptorListType;
  96
  97       /// Returns the list of tree levels (const)
  98         const LevelDescriptorListType& GetLevelDescriptorList() const { return mLevelDescriptorList; }
  99
 100       /// Clears the Descriptor
 101       void Clear();
 102
 103           //Create Attribute Descriptors from a file
 104         void createDescriptorfromFile(const std::string &i_file);
 105
 106
 107         /// test if an attribute is present in DescriptionList
 108         /// return level's name
 109         const std::string isExist(const std::string i_attr);
 110
 111     private:
 112       LevelDescriptorListType mLevelDescriptorList;
 113       /// Creates the mandatory level 0 descriptor called "Root"
 114       /// (assumes the list is empty)
 115       void CreateLevel0Descriptor();
 116
 117     };
 118     // EO class Descriptor
 119     //=====================================================================
 120   } // EO namespace tree
 121
 122 } // EO namespace creaImageIO
 123
 124 // EOF
 125 #endif