* src/gdcmFile.cxx, gdcmDocument.cxx : fix the bug on the group|element

[gdcm.git] / src / gdcmDictSet.cxx

diff --git a/src/gdcmDictSet.cxx b/src/gdcmDictSet.cxx
index fd2c0108272922df7e9888d999e15b24b897a1ff..c9cdfbcfb66a3544144ce1871779e8c3883f52d0 100644 (file)
--- a/src/gdcmDictSet.cxx
+++ b/src/gdcmDictSet.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDictSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/17 10:56:50 $
-  Version:   $Revision: 1.51 $
+  Date:      $Date: 2005/01/23 10:12:33 $
+  Version:   $Revision: 1.56 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -27,7 +27,6 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /** 
- * \ingroup DictSet
  * \brief   The Dictionary Set obtained with this constructor simply
  *          contains the Default Public dictionary.
  */
@@ -40,12 +39,11 @@ DictSet::DictSet()
 }
 
 /**
- * \ingroup DictSet
  * \brief  Destructor 
  */
 DictSet::~DictSet() 
 {
-   // Remove dictionnaries
+   // Remove dictionaries
    for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) 
    {
       Dict *entryToDelete = tag->second;
@@ -64,10 +62,10 @@ DictSet::~DictSet()
 //-----------------------------------------------------------------------------
 // Print
 /**
- * \ingroup DictSet
  * \brief   Print, in an informal fashion, the list of all the dictionaries
  *          contained is this DictSet, along with their respective content.
  * @param   os Output stream used for printing.
+ * @param indent Indentation string to be prepended during printing
  */
 void DictSet::Print(std::ostream &os, std::string const & )
 {
@@ -81,7 +79,6 @@ void DictSet::Print(std::ostream &os, std::string const & )
 //-----------------------------------------------------------------------------
 // Public
 /** 
- * \ingroup DictSet
  * \brief   Consider all the entries of the public dicom dictionary. 
  *          Build all list of all the tag names of all those entries.
  * \sa DictSet::GetPubDictTagNamesByCategory
@@ -96,7 +93,6 @@ void DictSet::Print(std::ostream &os, std::string const & )
 //}
 
 /** 
- * \ingroup DictSet
  * \brief   
  *          - Consider all the entries of the public dicom dictionary.
  *          - Build an hashtable whose keys are the names of the groups
@@ -133,7 +129,6 @@ void DictSet::Print(std::ostream &os, std::string const & )
 //}
 
 /**
- * \ingroup DictSet
  * \brief   Loads a dictionary from a specified file, and add it
  *          to already the existing ones contained in this DictSet.
  * @param   filename Absolute or relative filename containing the
@@ -151,7 +146,6 @@ Dict *DictSet::LoadDictFromFile(std::string const & filename,
 }
 
 /**
- * \ingroup DictSet
  * \brief   Retrieve the specified dictionary (when existing) from this
  *          DictSet.
  * @param   dictName The symbolic name of the searched dictionary.
@@ -202,10 +196,10 @@ DictEntry *DictSet::NewVirtualDictEntry( uint16_t group,
 
 /**
  * \brief   Obtain from the GDCM_DICT_PATH environnement variable the
- *          path to directory containing the dictionnaries. When
+ *          path to directory containing the dictionaries. When
  *          the environnement variable is absent the path is defaulted
  *          to "../Dicts/".
- * @return  path to directory containing the dictionnaries
+ * @return  path to directory containing the dictionaries
  */
 std::string DictSet::BuildDictPath() 
 {
@@ -232,34 +226,39 @@ std::string DictSet::BuildDictPath()
 
 
 /**
- * \brief   Initialise the visit of the Hash table (DictSetHT)
+ * \brief   Get the first entry while visiting the DictSet
+ * \return  The first Dict if found, otherwhise NULL
  */
-void DictSet::InitTraversal()
+Dict *DictSet::GetFirstEntry()
 {
    ItDictHt = Dicts.begin();
+   if( ItDictHt != Dicts.end() )
+      return ItDictHt->second;
+   return NULL;
 }
 
 /**
  * \brief   Get the next entry while visiting the Hash table (DictSetHT)
+ * \note : meaningfull only if GetFirstEntry already called
  * \return  The next Dict if found, otherwhise NULL
  */
 Dict *DictSet::GetNextEntry()
 {
-   if (ItDictHt != Dicts.end())
-   {
-      Dict *tmp = ItDictHt->second;
-      ++ItDictHt;
-
-      return tmp;
-   }
-   else
-   {
-      return NULL;
-   }
+   gdcmAssertMacro (ItDictHt != Dicts.end());
+  
+   ++ItDictHt;
+   if ( ItDictHt != Dicts.end() )
+      return ItDictHt->second;
+   return NULL;
 }
 
 //-----------------------------------------------------------------------------
 // Protected
+
+/**
+ * \brief   Adds a Dictionary to a DictSet
+ * \return  always true
+ */
 bool DictSet::AppendDict(Dict *newDict, DictKey const &name)
 {
    Dicts[name] = newDict;