X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.h;h=b1465abbe5a14cfceba179a1103a68626083179b;hb=faf9f777a09c115e44b29d40a0c6ea2d122fc1e7;hp=48e183d0deedc0fba06d02ea94c22c688fa12c64;hpb=61e1a3e0ce5480990a0d0b844cf0e86d1775306d;p=gdcm.git

diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h
index 48e183d0..b1465abb 100644
--- a/src/gdcmDocEntrySet.h
+++ b/src/gdcmDocEntrySet.h
@@ -1,54 +1,109 @@
-// gdcmDocEntrySet.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDocEntrySet.h,v $
+  Language:  C++
+  Date:      $Date: 2004/12/03 20:43:37 $
+  Version:   $Revision: 1.26 $
+                                                                                
+  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.html for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
 #ifndef GDCMDOCENTRYSET_H
 #define GDCMDOCENTRYSET_H
 
 #include "gdcmException.h"
-#include "gdcmDocEntry.h"
- 
-//-----------------------------------------------------------------------------
+#include <fstream>
 
-class GDCM_EXPORT gdcmDocEntrySet
+namespace gdcm 
 {
+class DocEntry;
+class ValEntry;
+class BinEntry;
+class SeqEntry;
+class DictEntry;
 
-public:
+typedef std::string BaseTagKey;
+//-----------------------------------------------------------------------------
 
-   gdcmDocEntrySet(int depth = 0); 
-   ~gdcmDocEntrySet(void);
+/**
+ * \ref DocEntrySet is an abstract base class for \ref ElementSet
+ * and \ref SQItem which are both containers for DocEntries.
+ * \ref ElementSet is based on the STL map<> container
+ * (see \ref ElementSet::TagHT), as opposed to \ref SQItem
+ * which is based on an STL list container (see \ref ListDocEntry).
+ * Since the syntax for adding a new element to a map<> or a list<>
+ * differ, \ref DocEntrySet is designed as an adapter to unify the
+ * interfaces of \ref DocEntrySet and \ref ElementSet.
+ * 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 Document::ParseDES 
+ * which calls \ref Document::ParseSQ, which in turns calls 
+ * \ref Document::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 DocEntrySet
+{
+friend class File;
+public:
+   DocEntrySet() {};
+   virtual ~DocEntrySet() {};
 
    /// \brief adds any type of entry to the entry set (pure vitual)
-   virtual bool AddEntry(gdcmDocEntry *Entry) = 0; // pure virtual
-	 
+   virtual bool AddEntry(DocEntry *Entry) = 0; // pure virtual
+ 
    /// \brief prints any type of entry to the entry set (pure vitual)
    virtual void Print (std::ostream & os = std::cout) = 0;// pure virtual
 
-   /// \brief Gets the depth level of a Dicom Header Entry embedded in a
-   ///        SeQuence
-   inline int GetDepthLevel(void) {return(SQDepthLevel);}
+   /// \brief write any type of entry to the entry set
+   virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0;// pure virtual
 
-   /// \brief Sets the depth level of a Dicom Header Entry embedded in a
-   /// SeQuence
-   inline void SetDepthLevel(int depth) {SQDepthLevel = depth;}
-         
+   virtual DocEntry* GetDocEntryByNumber(uint16_t group,
+                                         uint16_t element) = 0;
+   DocEntry* GetDocEntryByName(TagName const & name);
+   virtual std::string GetEntryByNumber(uint16_t group, uint16_t element) = 0;
+   std::string GetEntryByName(TagName const & name);
+   DictEntry* NewVirtualDictEntry( uint16_t group, 
+                                   uint16_t element,
+                                   TagName const & vr     = "unkn",
+                                   TagName const & fourth = "unkn",
+                                   TagName const & name   = "unkn" );
+  
 protected:
-   /// \brief   Build a new Element Value from all the low level arguments. 
-   ///         Check for existence of dictionary entry, and build
-   ///          a default one when absent (pure virtual)
-   virtual gdcmDocEntry *NewDocEntryByNumber(guint16 group, 
-                                             guint16 element)=0; // pure virtual
-
-   /// \brief   Build a new Element Value from all the low level arguments. 
-   ///         Check for existence of dictionary entry, and build
-   ///          a default one when absent (pure virtual)
-   virtual gdcmDocEntry *NewDocEntryByName  (std::string Name)=0;// pure virtual  
-   /// Gives the depth level of the element set inside SeQuences   
-   int SQDepthLevel;
-
-private:
-    
-};
 
+// DocEntry  related utilities 
+   ValEntry* NewValEntryByNumber(uint16_t group, 
+                                 uint16_t element);
+   BinEntry* NewBinEntryByNumber(uint16_t group, 
+                                 uint16_t element);
+   DocEntry* NewDocEntryByNumber(uint16_t group, 
+                                 uint16_t element); 
+   DocEntry* NewDocEntryByNumber(uint16_t group, 
+                                 uint16_t element,
+                                 TagName const & vr); 
+   DocEntry* NewDocEntryByName  (TagName const & name);
+   SeqEntry* NewSeqEntryByNumber(uint16_t group, 
+                                 uint16_t element);
+
+// DictEntry  related utilities
+   DictEntry *GetDictEntryByName  (TagName const & name);
+   DictEntry *GetDictEntryByNumber(uint16_t, uint16_t);
+
+};
 
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif