1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntrySet.h,v $
6 Date: $Date: 2005/02/10 11:20:34 $
7 Version: $Revision: 1.50 $
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
27 //-----------------------------------------------------------------------------
34 typedef std::string BaseTagKey;
36 //-----------------------------------------------------------------------------
39 * \ref DocEntrySet is an abstract base class for \ref ElementSet
40 * and \ref SQItem which are both containers for DocEntries.
41 * \ref ElementSet is based on the STL map<> container
42 * (see \ref ElementSet::TagHT), as opposed to \ref SQItem
43 * which is based on an STL list container (see \ref ListDocEntry).
44 * Since the syntax for adding a new element to a map<> or a list<>
45 * differ, \ref DocEntrySet is designed as an adapter to unify the
46 * interfaces of \ref DocEntrySet and \ref ElementSet.
47 * As an illustration of this design, please refer to the implementation
48 * of \ref AddEntry (or any pure virtual method) in both derived classes.
49 * This adapter unification of interfaces enables the parsing of a
50 * DICOM header containing (optionaly heavily nested) sequences to be
51 * written recursively [see \ref Document::ParseDES
52 * which calls \ref Document::ParseSQ, which in turns calls
53 * \ref Document::ParseDES ].
55 * \note Developpers should strongly resist to the temptation of adding
56 * members to this class since this class is designed as an adapter
57 * in the form of an abstract base class.
59 class GDCM_EXPORT DocEntrySet : public Base
62 /// Canonical Constructor
64 /// Canonical Destructor
65 virtual ~DocEntrySet() {};
67 /// \brief write any type of entry to the entry set
68 virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0;
70 /// \brief Remove all Entry in the entry set
71 virtual void ClearEntry() = 0;
72 /// \brief adds any type of entry to the entry set
73 virtual bool AddEntry(DocEntry *Entry) = 0;
74 /// \brief Removes any type of entry out of the entry set, and destroys it
75 virtual bool RemoveEntry(DocEntry *EntryToRemove) = 0;
76 /// \brief Removes any type of entry out of the entry set, DOESN'T destroy it
77 virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove) = 0;
78 /// Gets the first entry of any type of set
79 virtual DocEntry *GetFirstEntry()=0;
80 /// Gets the next entry of any type of set
81 virtual DocEntry *GetNextEntry()=0;
83 virtual std::string GetEntryValue(uint16_t group, uint16_t elem);
84 virtual void *GetEntryBinArea(uint16_t group, uint16_t elem);
85 virtual int GetEntryLength(uint16_t group, uint16_t elem);
86 virtual std::string GetEntryVR(uint16_t group, uint16_t elem);
88 /// \brief Gets any type of DocEntry, identified by its (group,elem)
89 virtual DocEntry *GetDocEntry(uint16_t group, uint16_t elem) = 0;
90 /// \brief Gets a ValEntry, identified by its (group, elem)
91 ValEntry *GetValEntry(uint16_t group, uint16_t elem);
92 /// \brief Gets a BinEntry, identified by its (group,elem)
93 BinEntry *GetBinEntry(uint16_t group, uint16_t elem);
94 /// \brief Gets a SeqEntry, identified by its (group,elem)
95 SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem);
97 bool SetValEntry(std::string const &content,
98 uint16_t group, uint16_t elem);
99 bool SetBinEntry(uint8_t *content, int lgth,
100 uint16_t group, uint16_t elem);
101 bool SetValEntry(std::string const &content, ValEntry *entry);
102 bool SetBinEntry(uint8_t *content, int lgth, BinEntry *entry);
104 ValEntry *InsertValEntry(std::string const &value,
105 uint16_t group, uint16_t elem,
106 TagName const &vr = GDCM_UNKNOWN);
107 BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
108 uint16_t group, uint16_t elem,
109 TagName const &vr = GDCM_UNKNOWN);
110 SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
111 /// tells us if the set contains no entry
112 virtual bool IsEmpty() = 0;
113 virtual bool CheckIfEntryExist(uint16_t group, uint16_t elem);
115 // DocEntry related utilities
116 ValEntry *NewValEntry(uint16_t group,uint16_t elem,
117 TagName const &vr = GDCM_UNKNOWN);
118 BinEntry *NewBinEntry(uint16_t group, uint16_t elem,
119 TagName const &vr = GDCM_UNKNOWN);
120 SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem);
122 // DictEntry related utilities
123 DictEntry *NewVirtualDictEntry(uint16_t group,uint16_t elem,
124 TagName const &vr = GDCM_UNKNOWN,
125 TagName const &vm = GDCM_UNKNOWN,
126 TagName const &name = GDCM_UNKNOWN );
129 // DictEntry related utilities
130 DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
131 DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
137 } // end namespace gdcm
138 //-----------------------------------------------------------------------------