]> Creatis software - gdcm.git/blobdiff - src/gdcmDict.h
BUG: Fix previously instroduce cmake bug, now should compile fine even without VTK...
[gdcm.git] / src / gdcmDict.h
index 5e56f3356eacb26d85376f0cecc2c939cb9b4920..1e83f1b692720b1c7f1f908184e6ecb067f02e31 100644 (file)
@@ -1,41 +1,80 @@
-////////////////////////////////////////////////////////////////////////////
-// A single DICOM dictionary i.e. a container for a collection of dictionary
-// entries. 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...
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDict.h,v $
+  Language:  C++
+  Date:      $Date: 2005/05/11 15:01:47 $
+  Version:   $Revision: 1.39 $
+                                                                                
+  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 GDCMDICT_H
 #define GDCMDICT_H
 
-#include <map>
-#include "gdcmCommon.h"
+#include "gdcmBase.h"
 #include "gdcmDictEntry.h"
 
-typedef map<TagKey,  gdcmDictEntry*> TagKeyHT;
-typedef map<TagName, gdcmDictEntry*> TagNameHT;
-
-/// Build a memory representation of a dicom dictionary by parsing
-/// an ascii file
-class GDCM_EXPORT gdcmDict {
-       string name;
-       string filename;
-   /// Access through TagKey (see alternate access with NameHt)
-       TagKeyHT  KeyHt;
-   /// Access through TagName (see alternate access with KeyHt)
-       TagNameHT NameHt;
+#include <iostream>
+#include <list>
+#include <map>
+
+namespace gdcm 
+{
+
+//-----------------------------------------------------------------------------
+typedef std::string DictKey;
+typedef std::map<TagKey, DictEntry>  TagKeyHT;
+//-----------------------------------------------------------------------------
+/**
+ * \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.
+ *           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 : public Base
+{
 public:
-       gdcmDict(string & FileName);
-       ~gdcmDict();
-       int AddNewEntry (gdcmDictEntry* NewEntry);
-       int ReplaceEntry(gdcmDictEntry* NewEntry);
-       int RemoveEntry (TagKey key);
-       int RemoveEntry (guint16 group, guint16 element);
-       gdcmDictEntry * GetTagByNumber(guint16 group, guint16 element);
-       gdcmDictEntry * GetTagByName(TagName name);
-       void Print(ostream&);
-       void PrintByKey(ostream&);
-       void PrintByName(ostream&);
-       TagKeyHT & GetEntries(void) { return KeyHt; }
+   Dict();
+   Dict(std::string const &filename);
+   ~Dict();
+
+// Print
+   void Print(std::ostream &os = std::cout, std::string const &indent = "");
+
+// Entries
+   bool AddEntry(DictEntry const &newEntry);
+   bool ReplaceEntry(DictEntry const &newEntry);
+   bool RemoveEntry (TagKey const &key);
+   bool RemoveEntry (uint16_t group, uint16_t elem);
+   void ClearEntry();
+   
+// Tag
+   DictEntry *GetEntry(uint16_t group, uint16_t elem);
+   DictEntry *GetEntry(TagKey const &key);
+
+   DictEntry *GetFirstEntry();
+   DictEntry *GetNextEntry();
+
+private:
+   /// ASCII file holding the Dictionnary
+   std::string Filename;
+
+   /// Access through TagKey
+   TagKeyHT KeyHt;
+   TagKeyHT::iterator ItKeyHt;
 };
+} // end namespace gdcm
 
+//-----------------------------------------------------------------------------
 #endif