According to Benoit's suggestion, and without any objection from anybody

[gdcm.git] / src / gdcmDict.h

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 9931f7bcab26a123c54d07c08c1f7bd776cf3178..60a335513da10f050f6b6c99238e4a3d80580a30 100644 (file)
--- a/src/gdcmDict.h
+++ b/src/gdcmDict.h
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDict.h,v $
   Language:  C++
-  Date:      $Date: 2004/06/20 18:08:47 $
-  Version:   $Revision: 1.15 $
+  Date:      $Date: 2005/01/08 15:03:59 $
+  Version:   $Revision: 1.29 $
                                                                                 
   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.htm for details.
+  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
@@ -19,74 +19,70 @@
 #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 
+{
 
+//-----------------------------------------------------------------------------
+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;
 //-----------------------------------------------------------------------------
 /*
- * \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.
+ * \defgroup 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(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);
 
 // Entries
-   bool AddNewEntry (gdcmDictEntry *NewEntry);
-   bool ReplaceEntry(gdcmDictEntry *NewEntry);
-   bool RemoveEntry (TagKey key);
-   bool RemoveEntry (guint16 group, guint16 element);
+   bool AddNewEntry (DictEntry const &newEntry);
+   bool ReplaceEntry(DictEntry const &newEntry);
+   bool RemoveEntry (TagKey const &key);
+   bool RemoveEntry (uint16_t group, uint16_t element);
    
 // Tag
-   gdcmDictEntry *GetDictEntryByName(TagName name);
-   gdcmDictEntry *GetDictEntryByNumber(guint16 group, guint16 element);
+   DictEntry *GetDictEntry(uint16_t group, uint16_t element);
 
-   std::list<std::string> *GetDictEntryNames(void);
-   std::map<std::string, std::list<std::string> > *
-        GetDictEntryNamesByCategory(void);
+  // EntryNamesList *GetDictEntryNames();
+  // EntryNamesByCatMap *GetDictEntryNamesByCategory();
 
-   /**
-    * \ingroup gdcmDict
-    * \brief   returns a ref to the Dicom Dictionary H table (map)
-    * return the Dicom Dictionary H table
-    */
-   inline TagKeyHT & GetEntriesByKey(void)  { return KeyHt; }
+   /// \brief  Returns a ref to the Dicom Dictionary H table (map)
+   /// @return the Dicom Dictionary H table
+   const TagKeyHT & GetEntriesByKey() const { return KeyHt; }
 
-   /**
-    * \ingroup gdcmDict
-    * \brief   returns a ref to the Dicom Dictionary H table (map)
-    * return the Dicom Dictionary H table
-    */
-   inline TagNameHT & GetEntriesByName(void)  { return NameHt; }
+   /// \brief  Returns a ref to the Dicom Dictionary H table (map)
+   /// @return the Dicom Dictionary H table
  
 private:
    /// ASCII file holding the Dictionnary
-   std::string filename;
-   /// Access through TagKey (see alternate access with NameHt)
+   std::string Filename;
+
+   /// Access through TagKey
    TagKeyHT  KeyHt;
-   /// Access through TagName (see alternate access with KeyHt)
-   TagNameHT NameHt;
+
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif