ENH: Slightly bigger patch:

[gdcm.git] / src / gdcmDict.h

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 10a585693b1a93de7b15dd2a687219730c313f42..dd4910dc3451a8ea33fb6a52913d26c50e12717b 100644 (file)
--- a/src/gdcmDict.h
+++ b/src/gdcmDict.h
@@ -1,5 +1,21 @@
-// gdcmDict.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDict.h,v $
+  Language:  C++
+  Date:      $Date: 2004/11/16 02:54:35 $
+  Version:   $Revision: 1.23 $
+                                                                                
+  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
 
@@ -10,60 +26,69 @@
 #include <list>
 #include <map>
 
-//-----------------------------------------------------------------------------
-typedef std::map<TagKey,  gdcmDictEntry*> TagKeyHT;
-typedef std::map<TagName, gdcmDictEntry*> TagNameHT;
+namespace gdcm 
+{
 
+//-----------------------------------------------------------------------------
+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 gdcmDict
- * \brief    gdcmDict acts a memory representation of a dicom dictionary i.e.
+ * \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:
-   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); 
+   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 *GetDictEntryByName(TagName const & name);
+   DictEntry *GetDictEntryByNumber(uint16_t group, uint16_t element);
+
+   EntryNamesList *GetDictEntryNames();
+   EntryNamesByCatMap *GetDictEntryNamesByCategory();
 
-   std::list<std::string> *GetDictEntryNames(void);
-   std::map<std::string, std::list<std::string> > *
-        GetDictEntryNamesByCategory(void);
+   /// \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 TagKeyHT & gdcmDict::GetEntries(void)  { return KeyHt; }
+   /// \brief  Returns a ref to the Dicom Dictionary H table (map)
+   /// @return the Dicom Dictionary H table
+   const TagNameHT & GetEntriesByName() const { return NameHt; }
  
 private:
    /// ASCII file holding the Dictionnary
-   std::string filename;
+   std::string Filename;
+
    /// Access through TagKey (see alternate access with NameHt)
-       TagKeyHT  KeyHt;
+   TagKeyHT  KeyHt;
+
    /// Access through TagName (see alternate access with KeyHt)
-       TagNameHT NameHt;
+   TagNameHT NameHt;
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif