]> Creatis software - gdcm.git/blob - src/gdcmDict.h
Doxygenation
[gdcm.git] / src / gdcmDict.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDict.h,v $
5   Language:  C++
6   Date:      $Date: 2005/10/20 15:24:08 $
7   Version:   $Revision: 1.43 $
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.html 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 "gdcmBase.h"
23 #include "gdcmDictEntry.h"
24
25 #include <iostream>
26 #include <fstream> // for ifstream
27 #include <list>
28 #include <map>
29
30 namespace gdcm 
31 {
32
33 //-----------------------------------------------------------------------------
34 typedef std::string DictKey;
35 typedef std::map<TagKey, DictEntry *>  TagKeyHT;
36
37 //-----------------------------------------------------------------------------
38 /**
39  * \brief    Dict acts a memory representation of a dicom dictionary i.e.
40  *           it is a container for a collection of dictionary entries.
41  *           The dictionary is loaded from in an ascii file.
42  *           There should be a single public dictionary (THE dictionary of
43  *           the actual DICOM v3) but as many shadow dictionaries as imagers 
44  *           combined with all software versions...
45  * \see DictSet
46  */
47 class GDCM_EXPORT Dict : public Base
48 {
49 public:
50    Dict();
51    Dict(std::string const &filename);
52    ~Dict();
53
54    bool AddDict(std::string const &filename);
55    bool RemoveDict(std::string const &filename);
56 // Print
57    void Print(std::ostream &os = std::cout, std::string const &indent = "");
58
59 // Entries
60    bool AddEntry(DictEntry *newEntry);
61    bool ReplaceEntry(DictEntry *newEntry);
62    bool RemoveEntry (TagKey const &key);
63    bool RemoveEntry (uint16_t group, uint16_t elem);
64    void ClearEntry();
65    
66 // Tag
67    DictEntry *GetEntry(uint16_t group, uint16_t elem);
68    DictEntry *GetEntry(TagKey const &key);
69
70    DictEntry *GetFirstEntry();
71    DictEntry *GetNextEntry();
72
73 private:
74    void DoTheLoadingJob(std::ifstream &ifs);
75
76    /// ASCII file holding the Dictionnary
77    std::string Filename;
78
79    /// Access through TagKey
80    TagKeyHT KeyHt;
81    TagKeyHT::iterator ItKeyHt;
82 };
83 } // end namespace gdcm
84
85 //-----------------------------------------------------------------------------
86 #endif