Fix mistypings

[gdcm.git] / src / gdcmElementSet.h

diff --git a/src/gdcmElementSet.h b/src/gdcmElementSet.h
index cca674552782e46cfb93a18930b906dafe26d31c..397f342c5290e650b61ac76b8f94f9f6e20d2d3d 100644 (file)
--- a/src/gdcmElementSet.h
+++ b/src/gdcmElementSet.h
@@ -1,38 +1,82 @@
-// gdcmElementSet.h
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmElementSet.h,v $
+  Language:  C++
+  Date:      $Date: 2007/09/17 12:16:02 $
+  Version:   $Revision: 1.59 $
+                                                                                
+  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 GDCMELEMENTSET_H
-#define GDCMELEMENTSET_H
+#ifndef _GDCMELEMENTSET_H_
+#define _GDCMELEMENTSET_H_
 
 #include "gdcmDocEntrySet.h"
-#include "gdcmDocEntry.h"
 
 #include <map>
-typedef std::string TagKey;
-typedef std::map<TagKey, gdcmDocEntry *> TagDocEntryHT;
+#include <iostream>
+#include <fstream>
 
+namespace GDCM_NAME_SPACE 
+{
+typedef std::map<TagKey, DocEntry *> TagDocEntryHT;
 
 //-----------------------------------------------------------------------------
-
-class GDCM_EXPORT gdcmElementSet : public gdcmDocEntrySet 
+/**
+ * \brief
+ *  ElementSet is based on the STL map<> container
+ * (see  ElementSet::TagHT), as opposed to  SQItem
+ * which is based on an STL list container (see  ListDocEntry).
+ * It contains the 'zero-level- DocEntry (out of any Dicom Sequence)
+ */
+class GDCM_EXPORT ElementSet : public DocEntrySet
 {
+   gdcmTypeMacro(ElementSet);
+
 public:
-   gdcmElementSet(void);
-   ~gdcmElementSet(void);
-   virtual bool AddEntry(gdcmDocEntry *Entry); // add to the H Table
+   virtual void Print(std::ostream &os = std::cout, 
+                      std::string const &indent = "" ); 
 
-   virtual void Print        (std::ostream &os = std::cout); 
-    
-protected:
+   void WriteContent(std::ofstream *fp, FileType filetype,
+                                    bool insideMetaElements, bool insideSequence); 
 
-private:
+   bool AddEntry(DocEntry *Entry);
+   bool RemoveEntry(DocEntry *EntryToRemove);
+   void ClearEntry();
+   
+   DocEntry *GetFirstEntry();
+   DocEntry *GetNextEntry();
+   DocEntry *GetDocEntry(uint16_t group, uint16_t elem);
+   /// Tells us if the ElementSet contains no entry
+   bool IsEmpty() { return TagHT.empty(); }
+   
+   int IsVRCoherent(uint16_t group);
 
-// Variables
+   virtual void Copy(DocEntrySet *set);
 
+protected:
+   ElementSet();
+   ~ElementSet();
+   /// \brief Some group are illegal withing some Dicom Documents
+   ///        Only the Document knows it.
+   bool MayIWrite(uint16_t )
+                 { return true; }
+private:
+// Variables
    /// Hash Table (map), to provide fast access
-   TagDocEntryHT tagHT;   
-   
+   TagDocEntryHT TagHT;
+   /// iterator, used to visit the TagHT variable
+   TagDocEntryHT::iterator ItTagHT;
 };
-
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif