X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.h;h=a9a5b0c565588407d7d06445e6a823b683508fdc;hb=9cd51041e87ba178719523a35ef7ad823924cbf6;hp=c1374a1bdab37dcdb8251153b2b63d9e1a02d5e0;hpb=5b89bede4607999aeb8d5b45311e7ee82f9471ef;p=gdcm.git

diff --git a/src/gdcmDocEntrySet.h b/src/gdcmDocEntrySet.h
index c1374a1b..a9a5b0c5 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/02/02 16:18:48 $
-  Version:   $Revision: 1.47 $
+  Date:      $Date: 2005/07/11 14:40:40 $
+  Version:   $Revision: 1.53 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -31,16 +31,16 @@ class BinEntry;
 class SeqEntry;
 class DictEntry;
 
-typedef std::string BaseTagKey;
+typedef TagKey BaseTagKey;
 
 //-----------------------------------------------------------------------------
 /**
  * \brief
  * \ref DocEntrySet is an abstract base class for \ref ElementSet
  * and \ref SQItem which are both containers for DocEntries.
- * \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).
+ *  - \ref ElementSet is based on the STL map<> container
+ * (see \ref ElementSet::TagHT)
+ *  - \ref SQItem is based on an STL list container (see \ref ListDocEntry).
  * Since the syntax for adding a new element to a map<> or a list<>
  * differ, \ref DocEntrySet is designed as an adapter to unify the
  * interfaces of \ref DocEntrySet and \ref ElementSet.
@@ -59,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
@@ -68,13 +70,14 @@ public:
    /// \brief Remove all Entry in the entry set
    virtual void ClearEntry() = 0;
    /// \brief adds any type of entry to the entry set
-   virtual bool AddEntry(DocEntry *Entry) = 0;
+   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);
@@ -85,27 +88,27 @@ public:
    /// \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);
+   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);
+   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);
+   SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem);
 
-   virtual bool SetValEntry(std::string const &content,
+   bool SetValEntry(std::string const &content,
                             uint16_t group, uint16_t elem);
-   virtual bool SetBinEntry(uint8_t *content, int lgth,
+   bool SetBinEntry(uint8_t *content, int lgth,
                             uint16_t group, uint16_t elem);
-   virtual bool SetValEntry(std::string const &content, ValEntry *entry);
-   virtual bool SetBinEntry(uint8_t *content, int lgth, BinEntry *entry);
+   bool SetValEntry(std::string const &content, ValEntry *entry);
+   bool SetBinEntry(uint8_t *content, int lgth, BinEntry *entry);
 
-   virtual ValEntry *InsertValEntry(std::string const &value,
+   ValEntry *InsertValEntry(std::string const &value,
                                     uint16_t group, uint16_t elem,
                                     TagName const &vr = GDCM_UNKNOWN);
-   virtual BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
+   BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
                                     uint16_t group, uint16_t elem,
                                     TagName const &vr = GDCM_UNKNOWN);
-   virtual SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
-
+   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);