-// gdcmDict.h
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmDict.h,v $
+ Language: C++
+ Date: $Date: 2004/10/12 04:35:45 $
+ Version: $Revision: 1.19 $
+
+ 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 "gdcmCommon.h"
#include "gdcmDictEntry.h"
+
+#include <iostream>
+#include <list>
#include <map>
+namespace gdcm
+{
-typedef std::map<TagKey, gdcmDictEntry*> TagKeyHT;
-typedef std::map<TagName, gdcmDictEntry*> TagNameHT;
+//-----------------------------------------------------------------------------
+typedef std::map<TagKey, DictEntry*> TagKeyHT;
+typedef std::map<TagName, DictEntry*> TagNameHT;
+//-----------------------------------------------------------------------------
/*
- * \defgroup gdcmDict
- * \brief gdcmDict acts a memory representation of a dicom dictionary i.e.
+ * \defgroup Dict
+ * \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 gdcmDictSet
+ * \see DictSet
*/
-class GDCM_EXPORT gdcmDict {
- std::string name;
- std::string filename;
- /// Access through TagKey (see alternate access with NameHt)
- TagKeyHT KeyHt;
- /// Access through TagName (see alternate access with KeyHt)
- TagNameHT NameHt;
+class GDCM_EXPORT Dict
+{
public:
- gdcmDict(std::string & FileName);
- ~gdcmDict();
- bool AddNewEntry (gdcmDictEntry* NewEntry);
- bool ReplaceEntry(gdcmDictEntry* NewEntry);
- bool RemoveEntry (TagKey key);
- bool RemoveEntry (guint16 group, guint16 element);
- gdcmDictEntry * GetTagByNumber(guint16 group, guint16 element);
- gdcmDictEntry * GetTagByName(TagName name);
- void Print(std::ostream&);
- void PrintByKey(std::ostream&);
- void PrintByName(std::ostream&);
-
- /**
- * \ingroup gdcmDict
- * \brief returns a ref to the Dicom Dictionary H table (map)
- * return the Dicom Dictionary H table
- */
- inline TagKeyHT & gdcmDict::GetEntries(void) {
- return KeyHt;
- }
+ Dict(std::string const & FileName);
+ ~Dict();
+
+// 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 (DictEntry *NewEntry);
+ bool ReplaceEntry(DictEntry *NewEntry);
+ bool RemoveEntry (TagKey key);
+ bool RemoveEntry (uint16_t group, uint16_t element);
+
+// Tag
+ DictEntry *GetDictEntryByName(TagName name);
+ DictEntry *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 TagKey (see alternate access with NameHt)
+ TagKeyHT KeyHt;
+ /// Access through TagName (see alternate access with KeyHt)
+ TagNameHT NameHt;
};
+} // end namespace gdcm
+//-----------------------------------------------------------------------------
#endif