Some normalizations :

[gdcm.git] / src / gdcmElementSet.h

diff --git a/src/gdcmElementSet.h b/src/gdcmElementSet.h
index 88a1c55b09c81fbf81fc5c3f45933b6807f26440..09499ad6f7cad8f345dfdbe94a77b3f918fa9a80 100644 (file)
--- a/src/gdcmElementSet.h
+++ b/src/gdcmElementSet.h
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.h,v $
   Language:  C++
-  Date:      $Date: 2004/07/02 13:55:28 $
-  Version:   $Revision: 1.10 $
+  Date:      $Date: 2005/01/23 10:12:34 $
+  Version:   $Revision: 1.35 $
                                                                                 
   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
@@ -19,41 +19,69 @@
 #ifndef GDCMELEMENTSET_H
 #define GDCMELEMENTSET_H
 
-#include <map>
-#include <iostream>
-#include "gdcmCommon.h"
 #include "gdcmDocEntrySet.h"
 
-class gdcmValEntry;
-class gdcmBinEntry;
-class gdcmSeqEntry;
+#include <map>
+#include <iostream>
+#include <fstream>
 
+namespace gdcm 
+{
+class ValEntry;
+class BinEntry;
+class SeqEntry;
 
-typedef std::map<gdcmTagKey, gdcmDocEntry *> TagDocEntryHT;
+typedef std::map<TagKey, DocEntry *> TagDocEntryHT;
 
 //-----------------------------------------------------------------------------
-
-class GDCM_EXPORT gdcmElementSet : public gdcmDocEntrySet
+/**
+ * \brief
+ * \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).
+ * It contains the 'zero-level- DocEntry (out of any Dicom Sequence)
+ */
+class GDCM_EXPORT ElementSet : public DocEntrySet
 {
 public:
-   gdcmElementSet(int);
-   ~gdcmElementSet(void);
-   virtual bool AddEntry(gdcmDocEntry *Entry);
-   virtual bool RemoveEntry(gdcmDocEntry *EntryToRemove);
+   ElementSet(int);
+   ~ElementSet();
+
+   virtual void Print(std::ostream &os = std::cout, std::string const &indent = "" ); 
+
+   bool AddEntry(DocEntry *Entry);
+   bool RemoveEntry(DocEntry *EntryToRemove);
+   bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
+   
+   void WriteContent(std::ofstream *fp, FileType filetype); 
+
+   DocEntry *GetFirstEntry();
+   DocEntry *GetNextEntry();
+   DocEntry *GetLastEntry();
+   DocEntry *GetPreviousEntry();
 
-   virtual void Print(std::ostream &os = std::cout); 
-   virtual void Write(FILE *fp, FileType filetype); 
+   DocEntry *GetDocEntry(uint16_t group, uint16_t elem);
+   ValEntry *GetValEntry(uint16_t group, uint16_t elem);
+   BinEntry *GetBinEntry(uint16_t group, uint16_t elem);
+   SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem);
+
+   bool IsEmpty() { return TagHT.empty(); };
+   bool CheckIfEntryExist(uint16_t group, uint16_t elem);
+   std::string GetEntry(uint16_t group, uint16_t elem);
 
-    
 protected:
+
+private:
 // Variables
    /// Hash Table (map), to provide fast access
-   TagDocEntryHT tagHT; 
+   TagDocEntryHT TagHT; 
+   /// Hash Table (map) iterator, used to visit the TagHT variable
+   TagDocEntryHT::iterator ItTagHT; 
      
-private:
-   
+   friend class DicomDir;        //For accessing private TagHT
+   friend class DocEntryArchive; //For accessing private TagHT
 };
-
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif