Some normalizations :

[gdcm.git] / src / gdcmDict.h

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 1e1f0754e17e2e5bce3da000978df99639df9592..8f9f0bb7906de143ff85e3c4dcb02c293402ed28 100644 (file)
--- a/src/gdcmDict.h
+++ b/src/gdcmDict.h
@@ -1,70 +1,86 @@
-// gdcmDict.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDict.h,v $
+  Language:  C++
+  Date:      $Date: 2005/01/20 11:39:49 $
+  Version:   $Revision: 1.34 $
+                                                                                
+  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+  l'Image). All rights reserved. See Doc/License.txt or
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
 #ifndef GDCMDICT_H
 #define GDCMDICT_H
 
-#include "gdcmCommon.h"
+#include "gdcmBase.h"
 #include "gdcmDictEntry.h"
 
 #include <iostream>
 #include <list>
 #include <map>
 
-//-----------------------------------------------------------------------------
-typedef std::map<TagKey,  gdcmDictEntry*> TagKeyHT;
-typedef std::map<TagName, gdcmDictEntry*> TagNameHT;
+namespace gdcm 
+{
 
 //-----------------------------------------------------------------------------
-/*
- * \defgroup gdcmDict
- * \brief    gdcmDict acts a memory representation of a dicom dictionary i.e.
- *           it is a container for a collection of dictionary entries. The
- *           dictionary is loaded from in an ascii file.
+typedef std::string DictKey;
+typedef std::map<TagKey, DictEntry>  TagKeyHT;
+typedef std::list<std::string>       EntryNamesList;
+typedef std::map<std::string, 
+            std::list<std::string> > EntryNamesByCatMap;
+//-----------------------------------------------------------------------------
+/**
+ * \ingroup Dict
+ * \brief    Dict acts a memory representation of a dicom dictionary i.e.
+ *           it is a container for a collection of dictionary entries.
+ *           The dictionary is loaded from in an ascii file.
  *           There should be a single public dictionary (THE dictionary of
  *           the actual DICOM v3) but as many shadow dictionaries as imagers 
  *           combined with all software versions...
- * \see gdcmDictSet
+ * \see DictSet
  */
-class GDCM_EXPORT gdcmDict {
+class GDCM_EXPORT Dict : public Base
+{
 public:
-   gdcmDict(std::string & FileName);
-       ~gdcmDict();
+   Dict(void);
+   Dict(std::string const & filename);
+   ~Dict();
 
 // Print
-       void Print(std::ostream &os = std::cout);
-       void PrintByKey(std::ostream &os = std::cout);
-       void PrintByName(std::ostream &os = std::cout); 
+   void Print(std::ostream &os = std::cout, std::string const & indent = "");
 
 // Entries
-   bool AddNewEntry (gdcmDictEntry *NewEntry);
-       bool ReplaceEntry(gdcmDictEntry *NewEntry);
-       bool RemoveEntry (TagKey key);
-       bool RemoveEntry (guint16 group, guint16 element);
-
+   void ClearEntry  ();
+   bool AddNewEntry (DictEntry const &newEntry);
+   bool ReplaceEntry(DictEntry const &newEntry);
+   bool RemoveEntry (TagKey const &key);
+   bool RemoveEntry (uint16_t group, uint16_t elem);
+   
 // Tag
-       gdcmDictEntry *GetDictEntryByName(TagName name);
-       gdcmDictEntry *GetDictEntryByNumber(guint16 group, guint16 element);
+   DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
+
+  // EntryNamesList *GetDictEntryNames();
+  // EntryNamesByCatMap *GetDictEntryNamesByCategory();
 
-   std::list<std::string> *GetDictEntryNames(void);
-   std::map<std::string, std::list<std::string> > *
-        GetDictEntryNamesByCategory(void);
+   DictEntry *GetFirstEntry();
+   DictEntry *GetNextEntry();
 
-   /**
-    * \ingroup gdcmDict
-    * \brief   returns a ref to the Dicom Dictionary H table (map)
-    * return the Dicom Dictionary H table
-    */
-   inline TagKeyHT & gdcmDict::GetEntries(void)  { return KeyHt; }
- 
 private:
-   std::string name;
-   std::string filename;
+   /// ASCII file holding the Dictionnary
+   std::string Filename;
 
-   /// Access through TagKey (see alternate access with NameHt)
-       TagKeyHT  KeyHt;
-   /// Access through TagName (see alternate access with KeyHt)
-       TagNameHT NameHt;
+   /// Access through TagKey
+   TagKeyHT KeyHt;
+   TagKeyHT::iterator ItKeyHt;
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif