X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictSet.h;h=28cc210dde6e4cdb62063c4cdc51d80d28d71589;hb=3370a8090c600a3d4dbe5573a62d1dddb59819f2;hp=0e2aed0b3a39a207fc4c6dface09f26b3f28b9fd;hpb=565a47ec4e037897aaf770aeccc5d67d7ad7b478;p=gdcm.git

diff --git a/src/gdcmDictSet.h b/src/gdcmDictSet.h
index 0e2aed0b..28cc210d 100644
--- a/src/gdcmDictSet.h
+++ b/src/gdcmDictSet.h
@@ -1,48 +1,82 @@
-// gdcmDictSet.h
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDictSet.h,v $
+  Language:  C++
+  Date:      $Date: 2004/09/27 08:39:06 $
+  Version:   $Revision: 1.26 $
+                                                                                
+  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 "gdcmDict.h"
 #include <map>
 #include <list>
-#include "gdcmCommon.h"
-#include "gdcmDict.h"
 
-////////////////////////////////////////////////////////////////////////////
-// Container for managing a set of loaded dictionaries. Sharing dictionaries
-// should avoid :
-// * reloading an allready loaded dictionary,
-// * having many in memory representations of the same dictionary.
+typedef std::string DictKey;
+typedef std::map<DictKey, gdcmDict*> DictSetHT;
 
-typedef string DictKey;
-typedef map<DictKey, gdcmDict*> DictSetHT;
+//-----------------------------------------------------------------------------
+/*
+ * \defgroup gdcmDictSet
+ * \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
+{
+public:
+   gdcmDictSet();
+   ~gdcmDictSet();
+
+   void Print(std::ostream& os);
+
+   std::list<std::string>* GetPubDictEntryNames();
+   std::map<std::string, std::list<std::string> > *
+       GetPubDictEntryNamesByCategory();
+
+   gdcmDict* LoadDictFromFile( std::string const & fileName,
+                               DictKey const & name );
+
+   gdcmDict* GetDict( DictKey const & DictName );
+
+   /// \brief   Retrieve the default reference DICOM V3 public dictionary.
+   gdcmDict* GetDefaultPubDict() { return GetDict(PUB_DICT_NAME); };
+
+   // \brief   Retrieve the virtual reference DICOM dictionary.
+   // \warning : not end user intended
+   // gdcmDict* GetVirtualDict() { return &VirtualEntry; };
+
+   gdcmDictEntry* NewVirtualDictEntry(uint16_t group, uint16_t element,
+                                      std::string vr     = "Unknown",
+                                      std::string fourth = "Unknown",
+                                      std::string name   = "Unknown");
+
+   static std::string BuildDictPath();
+
+protected:
+   bool AppendDict(gdcmDict *NewDict, DictKey const & name);
 
-class GDCM_EXPORT gdcmDictSet {
-private:
-	DictSetHT dicts;
-	int AppendDict(gdcmDict* NewDict);
-	void LoadDictFromFile(string filename, DictKey);
 private:
-	static string DictPath;      // Directory path to dictionaries
-	static string BuildDictPath(void);
-	static gdcmDict* DefaultPubDict;
-public:
-	static list<string> * GetPubDictTagNames(void);
-	static map<string, list<string> >* GetPubDictTagNamesByCategory(void);
-	static gdcmDict* LoadDefaultPubDict(void);
-
-	gdcmDictSet(void);
-	// TODO Swig int LoadDictFromFile(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(string filename);
-	// TODO Swig int LoadAllDictFromDirectory(string DirectoryName);
-	// TODO Swig string* GetAllDictNames();
-	//
-	void Print(ostream&);
-	gdcmDict* GetDict(DictKey DictName);
-	gdcmDict* GetDefaultPubDict(void);
+   /// Hash table of all dictionaries contained in this gdcmDictSet
+   DictSetHT Dicts;
+   /// Directory path to dictionaries
+   std::string DictPath;
+   /// H table for the on the fly created gdcmDictEntries  
+   TagKeyHT VirtualEntry; 
 };
 
+//-----------------------------------------------------------------------------
 #endif