ENH: Move the old setup.py to its new home

[gdcm.git] / src / gdcmDictSet.h

diff --git a/src/gdcmDictSet.h b/src/gdcmDictSet.h
index 4256ad8e3fc29defb1f33f0b6338ef1c05a3a42e..28cc210dde6e4cdb62063c4cdc51d80d28d71589 100644 (file)
--- a/src/gdcmDictSet.h
+++ b/src/gdcmDictSet.h
@@ -1,4 +1,20 @@
-// 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
@@ -10,6 +26,7 @@
 typedef std::string DictKey;
 typedef std::map<DictKey, gdcmDict*> DictSetHT;
 
+//-----------------------------------------------------------------------------
 /*
  * \defgroup gdcmDictSet
  * \brief  Container for managing a set of loaded dictionaries.
@@ -18,32 +35,48 @@ typedef std::map<DictKey, gdcmDict*> DictSetHT;
  * \par    having many in memory representations of the same dictionary
  *        (saving memory).
  */
-class GDCM_EXPORT gdcmDictSet {
+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);
+
 private:
    /// Hash table of all dictionaries contained in this gdcmDictSet
-       DictSetHT Dicts;
+   DictSetHT Dicts;
    /// Directory path to dictionaries
    std::string DictPath;
-       int AppendDict(gdcmDict* NewDict);
-       void LoadDictFromFile(std::string FileName, DictKey Name);
-   std::string BuildDictPath(void);
-public:
-   std::list<std::string> * GetPubDictTagNames(void);
-   std::map<std::string, std::list<std::string> >*
-       GetPubDictTagNamesByCategory(void);
-
-       // 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);
-       void Print(std::ostream& os);
-       gdcmDict* GetDict(DictKey DictName);
-       gdcmDict* GetDefaultPubDict(void);
+   /// H table for the on the fly created gdcmDictEntries  
+   TagKeyHT VirtualEntry; 
 };
 
+//-----------------------------------------------------------------------------
 #endif