]> Creatis software - gdcm.git/blobdiff - src/gdcmDict.cxx
Some normalizations :
[gdcm.git] / src / gdcmDict.cxx
index e8ad7f977f691e96c78eacccf63dbdc93437a588..162b79c04237662ef239768e29903e397fe99736 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDict.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/16 04:50:41 $
-  Version:   $Revision: 1.64 $
+  Date:      $Date: 2005/01/23 10:12:33 $
+  Version:   $Revision: 1.69 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -32,7 +32,7 @@ void FillDefaultDataDict(Dict *d);
 /**
  * \brief   Constructor
  */
-Dict::Dict(void)
+Dict::Dict( )
 {
    Filename="";
 }
@@ -91,6 +91,7 @@ Dict::~Dict()
  * \brief   Print all the dictionary entries contained in this dictionary.
  *          Entries will be sorted by tag i.e. the couple (group, element).
  * @param   os The output stream to be written to.
+ * @param indent Indentation string to be prepended during printing
  */
 void Dict::Print(std::ostream &os, std::string const & )
 {
@@ -114,7 +115,6 @@ void Dict::Print(std::ostream &os, std::string const & )
 //-----------------------------------------------------------------------------
 // Public
 /**
- * \ingroup Dict
  * \brief   Remove all Dicom Dictionary Entries
  */
 void Dict::ClearEntry()
@@ -125,7 +125,6 @@ void Dict::ClearEntry()
 }
 
 /**
- * \ingroup Dict
  * \brief  adds a new Dicom Dictionary Entry 
  * @param   newEntry entry to add 
  * @return  false if Dicom Element already exists
@@ -147,7 +146,6 @@ bool Dict::AddNewEntry(DictEntry const &newEntry)
 }
 
 /**
- * \ingroup Dict
  * \brief  replaces an already existing Dicom Element by a new one
  * @param   newEntry new entry (overwrites any previous one with same tag)
  * @return  false if Dicom Element doesn't exist
@@ -163,7 +161,6 @@ bool Dict::ReplaceEntry(DictEntry const &newEntry)
 }
 
 /**
- * \ingroup Dict
  * \brief  removes an already existing Dicom Dictionary Entry,
  *         identified by its Tag
  * @param   key (group|element)
@@ -198,10 +195,10 @@ bool Dict::RemoveEntry (uint16_t group, uint16_t elem)
 }
 
 /**
- * \brief   Get the dictionnary entry identified by a given tag (group,element)
+ * \brief   Get the dictionary entry identified by a given tag (group,element)
  * @param   group   group of the entry to be found
  * @param   elem element of the entry to be found
- * @return  the corresponding dictionnary entry when existing, NULL otherwise
+ * @return  the corresponding dictionary entry when existing, NULL otherwise
  */
 DictEntry *Dict::GetDictEntry(uint16_t group, uint16_t elem)
 {
@@ -215,10 +212,10 @@ DictEntry *Dict::GetDictEntry(uint16_t group, uint16_t elem)
 }
 
 /** 
- * \brief   Consider all the entries of the public dicom dictionnary. 
+ * \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
- * @return  A list of all entries of the public dicom dictionnary.
+ * @return  A list of all entries of the public dicom dictionary.
  */
 
  
@@ -236,27 +233,26 @@ DictEntry *Dict::GetDictEntry(uint16_t group, uint16_t elem)
 //}
 
 /** 
- * \ingroup Dict
- * \brief   Consider all the entries of the public dicom dictionnary.
+ * \brief   Consider all the entries of the public dicom dictionary.
  *          Build an hashtable whose keys are the names of the groups
  *          (fourth field in each line of dictionary) and whose corresponding
- *          values are lists of all the dictionnary entries among that
+ *          values are lists of all the dictionary entries among that
  *          group. Note that apparently the Dicom standard doesn't explicitely
  *          define a name (as a string) for each group.
  *          A typical usage of this method would be to enable a dynamic
  *          configuration of a Dicom file browser: the admin/user can
  *          select in the interface which Dicom tags should be displayed.
  * \warning Dicom *doesn't* define any name for any 'categorie'
- *          (the dictionnary fourth field was formerly NIH defined
+ *          (the dictionary fourth field was formerly NIH defined
  *           - and no longer he is-
  *           and will be removed when Dicom provides us a text file
- *           with the 'official' Dictionnary, that would be more friendly
- *           than asking us to perform a line by line check of the dictionnary
+ *           with the 'official' Dictionary, that would be more friendly
+ *           than asking us to perform a line by line check of the dictionary
  *           at the beginning of each year to -try to- guess the changes)
  *           Therefore : please NEVER use that fourth field :-(
  *
  * @return  An hashtable: whose keys are the names of the groups and whose
- *          corresponding values are lists of all the dictionnary entries
+ *          corresponding values are lists of all the dictionary entries
  *          among that group.
  */
  
@@ -275,30 +271,32 @@ DictEntry *Dict::GetDictEntry(uint16_t group, uint16_t elem)
 //}
 
 /**
- * \brief   Initialise the visit of the Hash table (KeyHt)
+ * \brief   Get the first entry while visiting the Dict entries
+ * \return  The first DicEntry if found, otherwhise NULL
  */
-void Dict::InitTraversal()
+DictEntry *Dict::GetFirstEntry()
 {
    ItKeyHt = KeyHt.begin();
+   if( ItKeyHt != KeyHt.end() )
+      return &(ItKeyHt->second);
+   return NULL;
 }
 
 /**
- * \brief   Get the next entry whil visiting the Hash table (KeyHt)
+ * \brief   Get the next entry while visiting the Hash table (KeyHt)
+ * \note : meaningfull only if GetFirstEntry already called
  * \return  The next DictEntry if found, otherwhise NULL
  */
 DictEntry *Dict::GetNextEntry()
 {
-   if (ItKeyHt != KeyHt.end())
-   {
-      DictEntry *tmp = &(ItKeyHt->second);
-      ++ItKeyHt;
+   gdcmAssertMacro (ItKeyHt != KeyHt.end());
 
-      return tmp;
-   }
-   else
    {
-      return NULL;
+      ++ItKeyHt;
+      if (ItKeyHt != KeyHt.end())
+         return &(ItKeyHt->second);
    }
+   return NULL;
 }
 
 //-----------------------------------------------------------------------------