X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.h;h=21eadf8b93e9b40dc6995d16f33b58aafbabb72a;hb=00e89cde772e18e4f2baab2b01680330af909d59;hp=4ed6d4a0e0f8bedac3f0e630297c4e1b305ef193;hpb=e40fc77cef3155aab87305ce2f8f14d1acbf158f;p=gdcm.git

diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h
index 4ed6d4a0..21eadf8b 100644
--- a/src/gdcmDocEntrySet.h
+++ b/src/gdcmDocEntrySet.h
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.h,v $
   Language:  C++
-  Date:      $Date: 2004/07/02 13:55:27 $
-  Version:   $Revision: 1.13 $
+  Date:      $Date: 2004/09/27 08:39:06 $
+  Version:   $Revision: 1.19 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
-  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
                                                                                 
      This software is distributed WITHOUT ANY WARRANTY; without even
      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
@@ -22,14 +22,36 @@
 #include "gdcmException.h"
 #include "gdcmDocEntry.h"
  
+typedef std::string gdcmBaseTagKey;
 //-----------------------------------------------------------------------------
 
+/**
+ * \ref gdcmDocEntrySet is an abstract base class for \ref gdcmElementSet
+ * and \ref gdcmSQItem which are both containers for gdcmDocEntries.
+ * \ref gdcmElementSet is based on the STL map<> container
+ * (see \ref gdcmElementSet::TagHT), as opposed to \ref gdcmSQItem
+ * which is based on an STL list container (see \ref gdcmSQItem::docEntries).
+ * Since the syntax for adding a new element to a map<> or a list<>
+ * differ, \ref gdcmDocEntrySet is designed as an adapter to unify the
+ * interfaces of \ref gdcmDocEntrySet and \ref gdcmElementSet.
+ * As an illustration of this design, please refer to the implementation
+ * of \ref AddEntry (or any pure virtual method) in both derived classes.
+ * This adapter unification of interfaces enables the parsing of a
+ * DICOM header containing (optionaly heavily nested) sequences to be
+ * written recursively [see \ref gdcmDocument::ParseDES 
+ * which calls \ref gdcmDocument::ParseSQ, which in turns calls 
+ * \ref gdcmDocument::ParseDES ].
+ *
+ * \note Developpers should strongly resist to the temptation of adding
+ *       members to this class since this class is designed as an adapter 
+ *       in the form of an abstract base class.
+ */
 class GDCM_EXPORT gdcmDocEntrySet
 {
 public:
 
-   gdcmDocEntrySet(int depth = 0); 
-   virtual ~gdcmDocEntrySet();
+   gdcmDocEntrySet() {}
+   virtual ~gdcmDocEntrySet() {}
 
    /// \brief adds any type of entry to the entry set (pure vitual)
    virtual bool AddEntry(gdcmDocEntry *Entry) = 0; // pure virtual
@@ -38,26 +60,18 @@ public:
    virtual void Print (std::ostream & os = std::cout) = 0;// pure virtual
 
    /// \brief write any type of entry to the entry set
-   virtual void Write (FILE *fp, FileType filetype)=0;// pure virtual
-
-   /// \brief Gets the depth level of a Dicom Header Entry embedded in a
-   ///        SeQuence
-   int GetDepthLevel(void) { return SQDepthLevel; }
-
-   /// \brief Sets the depth level of a Dicom Header Entry embedded in a
-   /// SeQuence
-   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
+   virtual void Write (FILE *fp, FileType filetype) = 0;// pure virtual
 
    virtual gdcmDocEntry* GetDocEntryByNumber(uint16_t group,
                                              uint16_t element) = 0;
-   gdcmDocEntry *GetDocEntryByName(std::string name);
+   gdcmDocEntry *GetDocEntryByName(std::string const & name);
    virtual std::string GetEntryByNumber(uint16_t group,uint16_t element) = 0;
-   std::string GetEntryByName(TagName name);
+   std::string GetEntryByName(TagName const & name);
    gdcmDictEntry *NewVirtualDictEntry(uint16_t group, 
                                       uint16_t element,
-                                      std::string vr     = "unkn",
-                                      std::string fourth = "unkn",
-                                      std::string name   = "unkn");
+                                      std::string const & vr     = "unkn",
+                                      std::string const & fourth = "unkn",
+                                      std::string const & name   = "unkn");
   
 protected:
 
@@ -68,17 +82,17 @@ protected:
                                      uint16_t element);
    gdcmDocEntry* NewDocEntryByNumber(uint16_t group, 
                                      uint16_t element); 
-   gdcmDocEntry* NewDocEntryByName  (std::string Name);
+   gdcmDocEntry* NewDocEntryByNumber(uint16_t group, 
+                                     uint16_t element,
+                                     std::string const & VR); 
+   gdcmDocEntry* NewDocEntryByName  (std::string const & name);
+   gdcmSeqEntry* NewSeqEntryByNumber(uint16_t group, 
+                                     uint16_t element);
 
 // DictEntry  related utilities
-   gdcmDictEntry *GetDictEntryByName  (std::string Name);
+   gdcmDictEntry *GetDictEntryByName  (std::string const & name);
    gdcmDictEntry *GetDictEntryByNumber(uint16_t, uint16_t);
 
-   /// Gives the depth level of the element set inside SeQuences   
-   int SQDepthLevel;
-
-private:
-    
 };