-////////////////////////////////////////////////////////////////////////////
-// 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: 2004/07/28 21:23:20 $
+ Version: $Revision: 1.17 $
+
+ 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.
+
+ 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 "gdcmDictEntry.h"
-typedef map<TagKey, gdcmDictEntry*> TagKeyHT;
-typedef map<TagName, gdcmDictEntry*> TagNameHT;
+#include <iostream>
+#include <list>
+#include <map>
+
+//-----------------------------------------------------------------------------
+typedef std::map<gdcmTagKey, gdcmDictEntry*> TagKeyHT;
+typedef std::map<TagName, gdcmDictEntry*> TagNameHT;
-class GDCM_EXPORT gdcmDict {
- string name;
- string filename;
- TagKeyHT KeyHt; // Both accesses with a TagKey or with a
- TagNameHT NameHt; // TagName are required.
+//-----------------------------------------------------------------------------
+/*
+ * \defgroup gdcmDict
+ * \brief gdcmDict 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 gdcmDictSet
+ */
+class GDCM_EXPORT gdcmDict
+{
public:
- gdcmDict(const char* FileName); // Reads Dict from ascii file
- int AddNewEntry (gdcmDictEntry* NewEntry);
- int ReplaceEntry(gdcmDictEntry* NewEntry);
- int RemoveEntry (TagKey key);
- int RemoveEntry (guint16 group, guint16 element);
- gdcmDictEntry * GetTagByKey(guint16 group, guint16 element);
- gdcmDictEntry * GetTagByName(TagName name);
- void Print(ostream&);
- void PrintByKey(ostream&);
- void PrintByName(ostream&);
- TagKeyHT & GetEntries(void) { return KeyHt; }
+ gdcmDict(std::string const & FileName);
+ ~gdcmDict();
+
+// Print
+ void Print(std::ostream &os = std::cout);
+ void PrintByKey(std::ostream &os = std::cout);
+ void PrintByName(std::ostream &os = std::cout);
+
+// Entries
+ bool AddNewEntry (gdcmDictEntry *NewEntry);
+ bool ReplaceEntry(gdcmDictEntry *NewEntry);
+ bool RemoveEntry (gdcmTagKey key);
+ bool RemoveEntry (uint16_t group, uint16_t element);
+
+// Tag
+ gdcmDictEntry *GetDictEntryByName(TagName name);
+ gdcmDictEntry *GetDictEntryByNumber(uint16_t group, uint16_t element);
+
+ std::list<std::string> *GetDictEntryNames();
+ std::map<std::string, std::list<std::string> > *
+ GetDictEntryNamesByCategory();
+
+ /// \brief Returns a ref to the Dicom Dictionary H table (map)
+ /// @return the Dicom Dictionary H table
+ TagKeyHT & GetEntriesByKey() { return KeyHt; }
+
+ /// \brief Returns a ref to the Dicom Dictionary H table (map)
+ /// @return the Dicom Dictionary H table
+ TagNameHT & GetEntriesByName() { return NameHt; }
+
+private:
+ /// ASCII file holding the Dictionnary
+ std::string Filename;
+ /// Access through gdcmTagKey (see alternate access with NameHt)
+ TagKeyHT KeyHt;
+ /// Access through TagName (see alternate access with KeyHt)
+ TagNameHT NameHt;
};
+//-----------------------------------------------------------------------------
#endif