ENH: * Huge cleanup:

[gdcm.git] / src / gdcmDict.h

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 6fcfd93a79cad98d69a9c4ba94cadbd91b3a5854..6764bbd40da206df1ec9259f1b147bff5d215f4b 100644 (file)
--- a/src/gdcmDict.h
+++ b/src/gdcmDict.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDict.h,v $
   Language:  C++
-  Date:      $Date: 2004/10/12 04:35:45 $
-  Version:   $Revision: 1.19 $
+  Date:      $Date: 2004/12/03 20:16:57 $
+  Version:   $Revision: 1.24 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -19,19 +19,22 @@
 #ifndef GDCMDICT_H
 #define GDCMDICT_H
 
-#include "gdcmCommon.h"
 #include "gdcmDictEntry.h"
 
 #include <iostream>
 #include <list>
 #include <map>
+
 namespace gdcm 
 {
 
 //-----------------------------------------------------------------------------
-typedef std::map<TagKey, DictEntry*> TagKeyHT;
-typedef std::map<TagName, DictEntry*> TagNameHT;
-
+typedef std::string DictKey;
+typedef std::map<TagKey, DictEntry>  TagKeyHT;
+typedef std::map<TagName, DictEntry> TagNameHT;
+typedef std::list<std::string>       EntryNamesList;
+typedef std::map<std::string, 
+            std::list<std::string> > EntryNamesByCatMap;
 //-----------------------------------------------------------------------------
 /*
  * \defgroup Dict
@@ -46,7 +49,7 @@ typedef std::map<TagName, DictEntry*> TagNameHT;
 class GDCM_EXPORT Dict
 {
 public:
-   Dict(std::string const & FileName);
+   Dict(std::string const & filename);
    ~Dict();
 
 // Print
@@ -55,32 +58,33 @@ public:
    void PrintByName(std::ostream &os = std::cout);
 
 // Entries
-   bool AddNewEntry (DictEntry *NewEntry);
-   bool ReplaceEntry(DictEntry *NewEntry);
-   bool RemoveEntry (TagKey key);
+   bool AddNewEntry (DictEntry const & newEntry);
+   bool ReplaceEntry(DictEntry const & newEntry);
+   bool RemoveEntry (TagKey const & key);
    bool RemoveEntry (uint16_t group, uint16_t element);
    
 // Tag
-   DictEntry *GetDictEntryByName(TagName name);
+   DictEntry *GetDictEntryByName(TagName const & name);
    DictEntry *GetDictEntryByNumber(uint16_t group, uint16_t element);
 
-   std::list<std::string> *GetDictEntryNames();
-   std::map<std::string, std::list<std::string> > *
-        GetDictEntryNamesByCategory();
+   EntryNamesList *GetDictEntryNames();
+   EntryNamesByCatMap *GetDictEntryNamesByCategory();
 
    /// \brief  Returns a ref to the Dicom Dictionary H table (map)
    /// @return the Dicom Dictionary H table
-   TagKeyHT & GetEntriesByKey()  { return KeyHt; }
+   const TagKeyHT & GetEntriesByKey() const { return KeyHt; }
 
    /// \brief  Returns a ref to the Dicom Dictionary H table (map)
    /// @return the Dicom Dictionary H table
-   TagNameHT & GetEntriesByName()  { return NameHt; }
+   const TagNameHT & GetEntriesByName() const { return NameHt; }
  
 private:
    /// 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;
 };