* Remove useless methods added by JPR for Python users. All was already

[gdcm.git] / src / gdcmDocEntrySet.h

diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h
index 7ac500c8d55d6d5f459dad95bde63a7e4e309a85..ec56a65b3907ec95ef0bae4267a602983e6e8ff2 100644 (file)
--- a/src/gdcmDocEntrySet.h
+++ b/src/gdcmDocEntrySet.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.h,v $
   Language:  C++
-  Date:      $Date: 2005/02/02 14:26:34 $
-  Version:   $Revision: 1.46 $
+  Date:      $Date: 2005/02/07 08:48:18 $
+  Version:   $Revision: 1.49 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -24,6 +24,7 @@
 
 namespace gdcm 
 {
+//-----------------------------------------------------------------------------
 class DocEntry;
 class ValEntry;
 class BinEntry;
@@ -31,8 +32,8 @@ class SeqEntry;
 class DictEntry;
 
 typedef std::string BaseTagKey;
-//-----------------------------------------------------------------------------
 
+//-----------------------------------------------------------------------------
 /**
  * \brief
  * \ref DocEntrySet is an abstract base class for \ref ElementSet
@@ -58,7 +59,9 @@ typedef std::string BaseTagKey;
 class GDCM_EXPORT DocEntrySet : public Base
 {
 public:
+   /// Canonical Constructor
    DocEntrySet() {};
+   /// Canonical Destructor
    virtual ~DocEntrySet() {};
 
    /// \brief write any type of entry to the entry set
@@ -72,8 +75,9 @@ public:
    virtual bool RemoveEntry(DocEntry *EntryToRemove) = 0;
    /// \brief Removes any type of entry out of the entry set, DOESN'T destroy it
    virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove) = 0;
-
+   /// Gets the first entry of any type of set
    virtual DocEntry *GetFirstEntry()=0;
+   /// Gets the next entry of any type of set
    virtual DocEntry *GetNextEntry()=0;
 
    virtual std::string GetEntryValue(uint16_t group, uint16_t elem);
@@ -104,15 +108,10 @@ public:
                                     uint16_t group, uint16_t elem,
                                     TagName const &vr = GDCM_UNKNOWN);
    virtual SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
-
+   /// tells us if the set contains no entry
    virtual bool IsEmpty() = 0;
    virtual bool CheckIfEntryExist(uint16_t group, uint16_t elem);
 
-   DictEntry *NewVirtualDictEntry(uint16_t group,uint16_t elem,
-                                  TagName const &vr     = GDCM_UNKNOWN,
-                                  TagName const &vm     = GDCM_UNKNOWN,
-                                  TagName const &name   = GDCM_UNKNOWN );
-
 // DocEntry  related utilities 
    ValEntry *NewValEntry(uint16_t group,uint16_t elem,
                          TagName const &vr = GDCM_UNKNOWN);
@@ -120,6 +119,12 @@ public:
                          TagName const &vr = GDCM_UNKNOWN);
    SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem);
 
+// DictEntry  related utilities 
+   DictEntry *NewVirtualDictEntry(uint16_t group,uint16_t elem,
+                                  TagName const &vr     = GDCM_UNKNOWN,
+                                  TagName const &vm     = GDCM_UNKNOWN,
+                                  TagName const &name   = GDCM_UNKNOWN );
+
 protected:
 // DictEntry  related utilities
    DictEntry *GetDictEntry(uint16_t group, uint16_t elem);