1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntrySet.h,v $
6 Date: $Date: 2005/01/24 16:10:52 $
7 Version: $Revision: 1.42 $
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.
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.
17 =========================================================================*/
19 #ifndef GDCMDOCENTRYSET_H
20 #define GDCMDOCENTRYSET_H
33 typedef std::string BaseTagKey;
34 //-----------------------------------------------------------------------------
38 * \ref DocEntrySet is an abstract base class for \ref ElementSet
39 * and \ref SQItem which are both containers for DocEntries.
40 * \ref ElementSet is based on the STL map<> container
41 * (see \ref ElementSet::TagHT), as opposed to \ref SQItem
42 * which is based on an STL list container (see \ref ListDocEntry).
43 * Since the syntax for adding a new element to a map<> or a list<>
44 * differ, \ref DocEntrySet is designed as an adapter to unify the
45 * interfaces of \ref DocEntrySet and \ref ElementSet.
46 * As an illustration of this design, please refer to the implementation
47 * of \ref AddEntry (or any pure virtual method) in both derived classes.
48 * This adapter unification of interfaces enables the parsing of a
49 * DICOM header containing (optionaly heavily nested) sequences to be
50 * written recursively [see \ref Document::ParseDES
51 * which calls \ref Document::ParseSQ, which in turns calls
52 * \ref Document::ParseDES ].
54 * \note Developpers should strongly resist to the temptation of adding
55 * members to this class since this class is designed as an adapter
56 * in the form of an abstract base class.
58 class GDCM_EXPORT DocEntrySet : public Base
60 friend class FileHelper;
63 virtual ~DocEntrySet() {};
65 // ------- '... =0;' stands for 'Pure Virtual'
67 /// \brief adds any type of entry to the entry set
68 virtual bool AddEntry(DocEntry *Entry) = 0;
70 /// \brief Removes any type of entry out of the entry set, and destroys it
71 virtual bool RemoveEntry(DocEntry *EntryToRemove)=0;
73 /// \brief Removes any type of entry out of the entry set, DOESN'T destroy it
74 virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove)= 0;
76 /// \brief write any type of entry to the entry set
77 virtual void WriteContent (std::ofstream *fp,
78 FileType filetype) = 0;
80 /// \brief Gets any type of DocEntry, identified by its (group,elem)
81 virtual DocEntry *GetDocEntry(uint16_t group,
84 /// \brief Gets a ValEntry, identified by its (group,elem)
85 virtual ValEntry *GetValEntry(uint16_t group,
87 /// \brief Gets a BinEntry, identified by its (group,elem)
88 virtual BinEntry *GetBinEntry(uint16_t group,
91 /// \brief Gets a SeqEntry, identified by its (group,elem)
92 virtual SeqEntry *GetSeqEntry(uint16_t group,
95 /// \brief Gets the 'string value' of a ValEntry
96 /// identified by its (group,elem) - Sorry for the name !...-
97 virtual std::string GetEntryValue(uint16_t group, uint16_t elem) = 0;
99 DictEntry *NewVirtualDictEntry(uint16_t group,
101 TagName const &vr = GDCM_UNKNOWN,
102 TagName const &vm = GDCM_UNKNOWN,
103 TagName const &name = GDCM_UNKNOWN );
106 // DocEntry related utilities
108 ValEntry *NewValEntry(uint16_t group,uint16_t elem,
109 TagName const &vr = GDCM_UNKNOWN);
110 BinEntry *NewBinEntry(uint16_t group,uint16_t elem,
111 TagName const &vr = GDCM_UNKNOWN);
112 SeqEntry *NewSeqEntry(uint16_t group,uint16_t elem);
114 // DictEntry related utilities
115 DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
116 DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
120 } // end namespace gdcm
121 //-----------------------------------------------------------------------------