ENH: Adding 'gdcm' namespace. Be nice with me this was a ~13000 lines patch. Also...

[gdcm.git] / src / gdcmDict.h

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 9931f7bcab26a123c54d07c08c1f7bd776cf3178..6fcfd93a79cad98d69a9c4ba94cadbd91b3a5854 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: 2004/10/12 04:35:45 $
+  Version:   $Revision: 1.19 $
                                                                                 
   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
@@ -25,26 +25,29 @@
 #include <iostream>
 #include <list>
 #include <map>
+namespace gdcm 
+{
 
 //-----------------------------------------------------------------------------
-typedef std::map<TagKey,  gdcmDictEntry*> TagKeyHT;
-typedef std::map<TagName, gdcmDictEntry*> TagNameHT;
+typedef std::map<TagKey, DictEntry*> TagKeyHT;
+typedef std::map<TagName, DictEntry*> TagNameHT;
 
 //-----------------------------------------------------------------------------
 /*
- * \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);
@@ -52,41 +55,36 @@ public:
    void PrintByName(std::ostream &os = std::cout);
 
 // Entries
-   bool AddNewEntry (gdcmDictEntry *NewEntry);
-   bool ReplaceEntry(gdcmDictEntry *NewEntry);
+   bool AddNewEntry (DictEntry *NewEntry);
+   bool ReplaceEntry(DictEntry *NewEntry);
    bool RemoveEntry (TagKey key);
-   bool RemoveEntry (guint16 group, guint16 element);
+   bool RemoveEntry (uint16_t group, uint16_t element);
    
 // Tag
-   gdcmDictEntry *GetDictEntryByName(TagName name);
-   gdcmDictEntry *GetDictEntryByNumber(guint16 group, guint16 element);
+   DictEntry *GetDictEntryByName(TagName name);
+   DictEntry *GetDictEntryByNumber(uint16_t group, uint16_t element);
 
-   std::list<std::string> *GetDictEntryNames(void);
+   std::list<std::string> *GetDictEntryNames();
    std::map<std::string, std::list<std::string> > *
-        GetDictEntryNamesByCategory(void);
+        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
+   TagKeyHT & GetEntriesByKey()  { 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
+   TagNameHT & GetEntriesByName()  { return NameHt; }
  
 private:
    /// ASCII file holding the Dictionnary
-   std::string filename;
+   std::string Filename;
    /// Access through TagKey (see alternate access with NameHt)
    TagKeyHT  KeyHt;
    /// Access through TagName (see alternate access with KeyHt)
    TagNameHT NameHt;
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif