]> Creatis software - gdcm.git/blob - src/gdcmDict.h
- guint16 and guint32 removed. Use ISO C uint16_t, uint32_t instead.
[gdcm.git] / src / gdcmDict.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDict.h,v $
5   Language:  C++
6   Date:      $Date: 2004/07/02 13:55:27 $
7   Version:   $Revision: 1.16 $
8                                                                                 
9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10   l'Image). All rights reserved. See Doc/License.txt or
11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
12                                                                                 
13      This software is distributed WITHOUT ANY WARRANTY; without even
14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15      PURPOSE.  See the above copyright notices for more information.
16                                                                                 
17 =========================================================================*/
18
19 #ifndef GDCMDICT_H
20 #define GDCMDICT_H
21
22 #include "gdcmCommon.h"
23 #include "gdcmDictEntry.h"
24
25 #include <iostream>
26 #include <list>
27 #include <map>
28
29 //-----------------------------------------------------------------------------
30 typedef std::map<gdcmTagKey, gdcmDictEntry*> TagKeyHT;
31 typedef std::map<TagName, gdcmDictEntry*> TagNameHT;
32
33 //-----------------------------------------------------------------------------
34 /*
35  * \defgroup gdcmDict
36  * \brief    gdcmDict acts a memory representation of a dicom dictionary i.e.
37  *           it is a container for a collection of dictionary entries. The
38  *           dictionary is loaded from in an ascii file.
39  *           There should be a single public dictionary (THE dictionary of
40  *           the actual DICOM v3) but as many shadow dictionaries as imagers 
41  *           combined with all software versions...
42  * \see gdcmDictSet
43  */
44 class GDCM_EXPORT gdcmDict {
45 public:
46    gdcmDict(std::string & FileName);
47    ~gdcmDict();
48
49 // Print
50    void Print(std::ostream &os = std::cout);
51    void PrintByKey(std::ostream &os = std::cout);
52    void PrintByName(std::ostream &os = std::cout);
53
54 // Entries
55    bool AddNewEntry (gdcmDictEntry *NewEntry);
56    bool ReplaceEntry(gdcmDictEntry *NewEntry);
57    bool RemoveEntry (gdcmTagKey key);
58    bool RemoveEntry (uint16_t group, uint16_t element);
59    
60 // Tag
61    gdcmDictEntry *GetDictEntryByName(TagName name);
62    gdcmDictEntry *GetDictEntryByNumber(uint16_t group, uint16_t element);
63
64    std::list<std::string> *GetDictEntryNames(void);
65    std::map<std::string, std::list<std::string> > *
66         GetDictEntryNamesByCategory(void);
67
68    /// \brief  Returns a ref to the Dicom Dictionary H table (map)
69    /// @return the Dicom Dictionary H table
70    TagKeyHT & GetEntriesByKey(void)  { return KeyHt; }
71
72    /// \brief  Returns a ref to the Dicom Dictionary H table (map)
73    /// @return the Dicom Dictionary H table
74    TagNameHT & GetEntriesByName(void)  { return NameHt; }
75  
76 private:
77    /// ASCII file holding the Dictionnary
78    std::string filename;
79    /// Access through gdcmTagKey (see alternate access with NameHt)
80    TagKeyHT  KeyHt;
81    /// Access through TagName (see alternate access with KeyHt)
82    TagNameHT NameHt;
83 };
84
85 //-----------------------------------------------------------------------------
86 #endif