* src/gdcmCommon.h : add the GDCM_UNKNOWN constant. This constant is to

[gdcm.git] / src / gdcmDictSet.h

diff --git a/src/gdcmDictSet.h b/src/gdcmDictSet.h
index b9d57a9d0caf5f5586fff9e6fa6eabd7ba126c0c..89b1ff883c9da962ffe99442d1f297ea0d7abffc 100644 (file)
--- a/src/gdcmDictSet.h
+++ b/src/gdcmDictSet.h
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDictSet.h,v $
   Language:  C++
-  Date:      $Date: 2004/07/02 13:55:27 $
-  Version:   $Revision: 1.21 $
+  Date:      $Date: 2005/01/05 15:38:28 $
+  Version:   $Revision: 1.31 $
                                                                                 
   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
@@ -19,63 +19,69 @@
 #ifndef GDCMDICTSET_H
 #define GDCMDICTSET_H
 
+#include "gdcmBase.h"
 #include "gdcmDict.h"
+
 #include <map>
 #include <list>
 
-typedef std::string DictKey;
-typedef std::map<DictKey, gdcmDict*> DictSetHT;
+namespace gdcm 
+{
+typedef std::map<DictKey, Dict*> DictSetHT;
 
 //-----------------------------------------------------------------------------
 /*
- * \defgroup gdcmDictSet
+ * \defgroup DictSet
  * \brief  Container for managing a set of loaded dictionaries.
  * \note   Hopefully, sharing dictionaries should avoid
  * \par    reloading an already loaded dictionary (saving time)
  * \par    having many in memory representations of the same dictionary
  *        (saving memory).
  */
-class GDCM_EXPORT gdcmDictSet {
+class GDCM_EXPORT DictSet : public Base
+{
 public:
-   // TODO Swig int LoadDictFromFile(std::string filename);
-   // QUESTION: the following function might not be thread safe !? Maybe
-   //           we need some mutex here, to avoid concurent creation of
-   //           the same dictionary !?!?!
-   // TODO Swig int LoadDictFromName(std::string filename);
-   // TODO Swig int LoadAllDictFromDirectory(std::string DirectoryName);
-   // TODO Swig std::string* GetAllDictNames();
-   gdcmDictSet(void);
-   ~gdcmDictSet(void);
+   DictSet();
+   ~DictSet();
 
    void Print(std::ostream& os);
 
-   std::list<std::string> *GetPubDictEntryNames(void);
-   std::map<std::string, std::list<std::string> > *
-       GetPubDictEntryNamesByCategory(void);
+   EntryNamesList * GetPubDictEntryNames();
+   EntryNamesByCatMap * GetPubDictEntryNamesByCategory();
+
+   Dict* LoadDictFromFile( std::string const & fileName,
+                           DictKey const & name );
+
+   Dict* GetDict( DictKey const & DictName );
 
-   gdcmDict *LoadDictFromFile(std::string FileName, DictKey Name);
+   /// \brief   Retrieve the default reference DICOM V3 public dictionary.
+   Dict* GetDefaultPubDict() { return GetDict(PUB_DICT_NAME); };
 
-   gdcmDict *GetDict(DictKey DictName);
-   gdcmDict *GetDefaultPubDict(void);
+   // \brief   Retrieve the virtual reference DICOM dictionary.
+   // \warning : not end user intended
+   // Dict* GetVirtualDict() { return &VirtualEntry; };
 
-   gdcmDictEntry *NewVirtualDictEntry(uint16_t group, uint16_t element,
-                                      std::string vr     = "Unknown",
-                                      std::string fourth = "Unknown",
-                                      std::string name   = "Unknown");
+   DictEntry* NewVirtualDictEntry(uint16_t group, uint16_t element,
+                                  TagName vr     = GDCM_UNKNOWN,
+                                  TagName fourth = GDCM_UNKNOWN,
+                                  TagName name   = GDCM_UNKNOWN);
 
-   static std::string BuildDictPath(void);
+   static std::string BuildDictPath();
 
 protected:
-   bool AppendDict(gdcmDict *NewDict,DictKey Name);
+   bool AppendDict(Dict *NewDict, DictKey const & name);
 
 private:
-   /// Hash table of all dictionaries contained in this gdcmDictSet
+   /// Hash table of all dictionaries contained in this DictSet
    DictSetHT Dicts;
+
    /// Directory path to dictionaries
    std::string DictPath;
-   /// H table for the on the fly created gdcmDictEntries  
-   std::map<std::string,gdcmDictEntry *> virtualEntry;
+
+   /// H table for the on the fly created DictEntries  
+   TagKeyHT VirtualEntry; 
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif