Fix mistypings

[gdcm.git] / src / gdcmDict.h

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 8add2a6bfe75bda9e4ae4b21f89599e1b36a9561..d72fec8df51e529bdad7e1a41f085bfe45bfa18f 100644 (file)
--- a/src/gdcmDict.h
+++ b/src/gdcmDict.h
@@ -1,70 +1,95 @@
-// gdcmDict.h
-//-----------------------------------------------------------------------------
-#ifndef GDCMDICT_H
-#define GDCMDICT_H
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDict.h,v $
+  Language:  C++
+  Date:      $Date: 2007/08/22 16:14:03 $
+  Version:   $Revision: 1.51 $
+                                                                                
+  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 "gdcmRefCounter.h"
 #include "gdcmDictEntry.h"
 
 #include <iostream>
+#include <fstream> // for ifstream
 #include <list>
 #include <map>
 
+namespace GDCM_NAME_SPACE 
+{
+
 //-----------------------------------------------------------------------------
-typedef std::map<TagKey,  gdcmDictEntry*> TagKeyHT;
-typedef std::map<TagName, gdcmDictEntry*> TagNameHT;
+typedef std::string DictKey;
+typedef std::map<TagKey, DictEntry *>  TagKeyHT;
 
 //-----------------------------------------------------------------------------
-/*
- * \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.
+/**
+ * \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 RefCounter
+{
+   gdcmTypeMacro(Dict);
+
 public:
-   gdcmDict(std::string & FileName);
-       ~gdcmDict();
+/// \brief Contructs an empty Dict with a RefCounter
+   static Dict *New() {return new Dict();}
+/// \brief Contructs a Dict with a RefCounter
+   static Dict *New(std::string const &filename) {return new Dict(filename);}
 
+   bool AddDict(std::string const &filename);
+   bool RemoveDict(std::string const &filename);
 // 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);
-
+   bool AddEntry(DictEntry *newEntry);
+  // bool ReplaceEntry(DictEntry *newEntry); // useless ?
+   bool RemoveEntry (TagKey const &key);
+   bool RemoveEntry (uint16_t group, uint16_t elem);
+   void ClearEntry();
+   
 // Tag
-       gdcmDictEntry * GetTagByName(TagName name);
-       gdcmDictEntry * GetTagByNumber(guint16 group, guint16 element);
+   DictEntry *GetEntry(uint16_t group, uint16_t elem);
+   DictEntry *GetEntry(TagKey const &key);
+
+   DictEntry *GetFirstEntry();
+   DictEntry *GetNextEntry();
 
-   std::list<std::string> *GetTagNames(void);
-   std::map<std::string, std::list<std::string> > *
-        GetTagNamesByCategory(void);
+protected:
+   Dict();
+   Dict(std::string const &filename);
+   ~Dict();
 
-   /**
-    * \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;
+   void DoTheLoadingJob(std::ifstream &ifs);
+
+   /// 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;
+   /// Iterator for the entries
+   TagKeyHT::iterator ItKeyHt;
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif