Fix mistypings

[gdcm.git] / src / gdcmElementSet.h

diff --git a/src/gdcmElementSet.h b/src/gdcmElementSet.h
index 030bbf562c07ae6b81571f68299f1f71a8154981..397f342c5290e650b61ac76b8f94f9f6e20d2d3d 100644 (file)
--- a/src/gdcmElementSet.h
+++ b/src/gdcmElementSet.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:27 $
-  Version:   $Revision: 1.28 $
+  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
@@ -16,8 +16,8 @@
                                                                                 
 =========================================================================*/
 
-#ifndef GDCMELEMENTSET_H
-#define GDCMELEMENTSET_H
+#ifndef _GDCMELEMENTSET_H_
+#define _GDCMELEMENTSET_H_
 
 #include "gdcmDocEntrySet.h"
 
@@ -25,50 +25,56 @@
 #include <iostream>
 #include <fstream>
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE 
 {
-class ValEntry;
-class BinEntry;
-class SeqEntry;
-
 typedef std::map<TagKey, DocEntry *> TagDocEntryHT;
 
 //-----------------------------------------------------------------------------
-
+/**
+ * \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:
-   ElementSet(int);
-   ~ElementSet();
+   virtual void Print(std::ostream &os = std::cout, 
+                      std::string const &indent = "" ); 
 
-   virtual void Print(std::ostream &os = std::cout); 
+   void WriteContent(std::ofstream *fp, FileType filetype,
+                                    bool insideMetaElements, bool insideSequence); 
 
    bool AddEntry(DocEntry *Entry);
    bool RemoveEntry(DocEntry *EntryToRemove);
-   bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
+   void ClearEntry();
    
-   void WriteContent(std::ofstream *fp, FileType filetype); 
+   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(); }
    
-   /// Accessor to \ref TagHT
-   // Do not expose this to user (public API) ! 
-   // A test is using it thus put it in public (matt)
-   TagDocEntryHT const &GetTagHT() const { return TagHT; };
+   int IsVRCoherent(uint16_t group);
 
-   void Initialize();
-   DocEntry *GetNextEntry();
+   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; 
-   /// Hash Table (map) iterator, used to visit the TagHT variable
-   TagDocEntryHT::iterator ItTagHT; 
- 
-   friend class Document;
-   friend class DicomDir; //For accessing private TagHT
-   friend class DocEntryArchive; //For accessing private TagHT
+   TagDocEntryHT TagHT;
+   /// iterator, used to visit the TagHT variable
+   TagDocEntryHT::iterator ItTagHT;
 };
 } // end namespace gdcm
 //-----------------------------------------------------------------------------