Fix mistypings

[gdcm.git] / src / gdcmDictSet.h

diff --git a/src/gdcmDictSet.h b/src/gdcmDictSet.h
index e970b80bc899c89117f550cc6ba17c33130a5d23..9e2e2d777580a759e99c168c6a4d5d67d0e32a82 100644 (file)
--- a/src/gdcmDictSet.h
+++ b/src/gdcmDictSet.h
@@ -1,65 +1,90 @@
-// gdcmDictSet.h
-//-----------------------------------------------------------------------------
-#ifndef GDCMDICTSET_H
-#define GDCMDICTSET_H
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDictSet.h,v $
+  Language:  C++
+  Date:      $Date: 2007/08/22 16:14:04 $
+  Version:   $Revision: 1.55 $
+                                                                                
+  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 _GDCMDICTSET_H
+#define _GDCMDICTSET_H
 
+#include "gdcmRefCounter.h"
 #include "gdcmDict.h"
+#include "gdcmGlobal.h"
+
 #include <map>
 #include <list>
 
-typedef std::string DictKey;
-typedef std::map<DictKey, gdcmDict*> DictSetHT;
+namespace GDCM_NAME_SPACE 
+{
+//-----------------------------------------------------------------------------
+typedef std::map<DictKey, Dict*> DictSetHT;
 
 //-----------------------------------------------------------------------------
-/*
- * \defgroup gdcmDictSet
- * \brief  Container for managing a set of loaded dictionaries.
+/**
+ * \brief  Container for managing a set of loaded dictionaries (Dict).
  * \note   Hopefully, sharing dictionaries should avoid
- * \par    reloading an already loaded dictionary (saving time)
- * \par    having many in memory representations of the same dictionary
+ *         - reloading an already loaded dictionary (saving time)
+ *         - having many in memory representations of the same dictionary
  *        (saving memory).
  */
-class GDCM_EXPORT gdcmDictSet {
+class GDCM_EXPORT DictSet : public RefCounter
+{
+   gdcmTypeMacro(DictSet);
+
 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);
+/// \brief Contructs a DictSet with a RefCounter
+   static DictSet *New() {return new DictSet();}
+
+   void Print(std::ostream &os = std::cout, std::string const &indent = "" );
 
-   void Print(std::ostream& os);
+   // Probabely useless !
+   //EntryNamesList *GetPubDictEntryNames();
+   //EntryNamesByCatMap *GetPubDictEntryNamesByCategory();
 
-   std::list<std::string> *GetPubDictEntryNames(void);
-   std::map<std::string, std::list<std::string> > *
-       GetPubDictEntryNamesByCategory(void);
+   Dict *LoadDictFromFile( std::string const &fileName,
+                           DictKey const &name );
 
-   gdcmDict *LoadDictFromFile(std::string FileName, DictKey Name);
+   Dict *GetDict( DictKey const &DictName );
 
-   gdcmDict *GetDict(DictKey DictName);
-   gdcmDict *GetDefaultPubDict(void);
+   /// \brief   Returns the default reference DICOM V3 public dictionary.
+   //Dict* GetDefaultPubDict() { return GetDict(PUB_DICT_NAME); }
+   Dict* GetDefaultPubDict() { return Global::DefaultPubDict; } 
+   
+   // \ brief   Returns the virtual references DICOM dictionary.
+   // \ warning : not end user intended
+   // Dict *GetVirtualDict() { return &VirtualEntries; }
 
-   gdcmDictEntry *NewVirtualDictEntry(guint16 group, guint16 element,
-                                      std::string vr     = "Unknown",
-                                      std::string fourth = "Unknown",
-                                      std::string name   = "Unknown");
+   Dict *GetFirstDict();
+   Dict *GetNextDict();
 
-   static std::string BuildDictPath(void);
+   static std::string BuildDictPath();
 
 protected:
-   bool AppendDict(gdcmDict *NewDict,DictKey Name);
+   DictSet();
+   ~DictSet();
 
 private:
-   /// Hash table of all dictionaries contained in this gdcmDictSet
+   /// Hash table of all dictionaries contained in this DictSet
    DictSetHT Dicts;
+   /// Iterator to visit the Dictionaries of a given DictSet
+   DictSetHT::iterator ItDictHt;
+
    /// Directory path to dictionaries
    std::string DictPath;
-
-   std::map<std::string,gdcmDictEntry *> virtualEntry;
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif