X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.h;h=ec56a65b3907ec95ef0bae4267a602983e6e8ff2;hb=7acc5e4b2b49b027c93e29f871980d0b40fed541;hp=9eaa474bda5e79849999835f733ce3ceccf70cc3;hpb=a4cff04fcd2023f798a9f1ef6bc9307269abd185;p=gdcm.git

diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h
index 9eaa474b..ec56a65b 100644
--- a/src/gdcmDocEntrySet.h
+++ b/src/gdcmDocEntrySet.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/26 11:42:02 $
-  Version:   $Revision: 1.45 $
+  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
@@ -69,11 +72,12 @@ public:
    /// \brief adds any type of entry to the entry set
    virtual bool AddEntry(DocEntry *Entry) = 0;
    /// \brief Removes any type of entry out of the entry set, and destroys it
-   virtual bool RemoveEntry(DocEntry *EntryToRemove)=0;
+   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;
-
+   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);
@@ -82,13 +86,13 @@ public:
    virtual std::string GetEntryVR(uint16_t group, uint16_t elem);
 
    /// \brief Gets any type of DocEntry, identified by its (group,elem)
-   virtual DocEntry *GetDocEntry(uint16_t group,uint16_t elem) = 0;
-   /// \brief Gets a ValEntry, identified by its (group,elem)
-   virtual ValEntry *GetValEntry(uint16_t group,uint16_t elem);
+   virtual DocEntry *GetDocEntry(uint16_t group, uint16_t elem) = 0;
+   /// \brief Gets a ValEntry, identified by its (group, elem)
+   virtual ValEntry *GetValEntry(uint16_t group, uint16_t elem);
    /// \brief Gets a BinEntry, identified by its (group,elem)
-   virtual BinEntry *GetBinEntry(uint16_t group,uint16_t elem);
+   virtual BinEntry *GetBinEntry(uint16_t group, uint16_t elem);
    /// \brief Gets a SeqEntry, identified by its (group,elem)
-   virtual SeqEntry *GetSeqEntry(uint16_t group,uint16_t elem);
+   virtual SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem);
 
    virtual bool SetValEntry(std::string const &content,
                             uint16_t group, uint16_t elem);
@@ -104,21 +108,22 @@ 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);
-   BinEntry *NewBinEntry(uint16_t group,uint16_t elem,
+   BinEntry *NewBinEntry(uint16_t group, uint16_t elem,
                          TagName const &vr = GDCM_UNKNOWN);
-   SeqEntry *NewSeqEntry(uint16_t group,uint16_t elem);
+   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