]> Creatis software - gdcm.git/blobdiff - src/gdcmDict.h
Fix mistypings
[gdcm.git] / src / gdcmDict.h
index 6fcfd93a79cad98d69a9c4ba94cadbd91b3a5854..d72fec8df51e529bdad7e1a41f085bfe45bfa18f 100644 (file)
@@ -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: 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
                                                                                 
 =========================================================================*/
 
-#ifndef GDCMDICT_H
-#define GDCMDICT_H
+#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 
+
+namespace GDCM_NAME_SPACE 
 {
 
 //-----------------------------------------------------------------------------
-typedef std::map<TagKey, DictEntry*> TagKeyHT;
-typedef std::map<TagName, DictEntry*> TagNameHT;
+typedef std::string DictKey;
+typedef std::map<TagKey, DictEntry *>  TagKeyHT;
 
 //-----------------------------------------------------------------------------
-/*
- * \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.
+ *           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 DictSet
  */
-class GDCM_EXPORT Dict
+class GDCM_EXPORT Dict : public RefCounter
 {
+   gdcmTypeMacro(Dict);
+
 public:
-   Dict(std::string const & FileName);
-   ~Dict();
+/// \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 (DictEntry *NewEntry);
-   bool ReplaceEntry(DictEntry *NewEntry);
-   bool RemoveEntry (TagKey key);
-   bool RemoveEntry (uint16_t group, uint16_t 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
-   DictEntry *GetDictEntryByName(TagName name);
-   DictEntry *GetDictEntryByNumber(uint16_t group, uint16_t element);
+   DictEntry *GetEntry(uint16_t group, uint16_t elem);
+   DictEntry *GetEntry(TagKey const &key);
 
-   std::list<std::string> *GetDictEntryNames();
-   std::map<std::string, std::list<std::string> > *
-        GetDictEntryNamesByCategory();
+   DictEntry *GetFirstEntry();
+   DictEntry *GetNextEntry();
 
-   /// \brief  Returns a ref to the Dicom Dictionary H table (map)
-   /// @return the Dicom Dictionary H table
-   TagKeyHT & GetEntriesByKey()  { return KeyHt; }
+protected:
+   Dict();
+   Dict(std::string const &filename);
+   ~Dict();
 
-   /// \brief  Returns a ref to the Dicom Dictionary H table (map)
-   /// @return the Dicom Dictionary H table
-   TagNameHT & GetEntriesByName()  { return NameHt; }
 private:
+   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