1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntrySet.h,v $
6 Date: $Date: 2005/02/02 16:18:48 $
7 Version: $Revision: 1.47 $
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
63 virtual ~DocEntrySet() {};
65 /// \brief write any type of entry to the entry set
66 virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0;
68 /// \brief Remove all Entry in the entry set
69 virtual void ClearEntry() = 0;
70 /// \brief adds any type of entry to the entry set
71 virtual bool AddEntry(DocEntry *Entry) = 0;
72 /// \brief Removes any type of entry out of the entry set, and destroys it
73 virtual bool RemoveEntry(DocEntry *EntryToRemove) = 0;
74 /// \brief Removes any type of entry out of the entry set, DOESN'T destroy it
75 virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove) = 0;
77 virtual DocEntry *GetFirstEntry()=0;
78 virtual DocEntry *GetNextEntry()=0;
80 virtual std::string GetEntryValue(uint16_t group, uint16_t elem);
81 virtual void *GetEntryBinArea(uint16_t group, uint16_t elem);
82 virtual int GetEntryLength(uint16_t group, uint16_t elem);
83 virtual std::string GetEntryVR(uint16_t group, uint16_t elem);
85 /// \brief Gets any type of DocEntry, identified by its (group,elem)
86 virtual DocEntry *GetDocEntry(uint16_t group, uint16_t elem) = 0;
87 /// \brief Gets a ValEntry, identified by its (group, elem)
88 virtual ValEntry *GetValEntry(uint16_t group, uint16_t elem);
89 /// \brief Gets a BinEntry, identified by its (group,elem)
90 virtual BinEntry *GetBinEntry(uint16_t group, uint16_t elem);
91 /// \brief Gets a SeqEntry, identified by its (group,elem)
92 virtual SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem);
94 virtual bool SetValEntry(std::string const &content,
95 uint16_t group, uint16_t elem);
96 virtual bool SetBinEntry(uint8_t *content, int lgth,
97 uint16_t group, uint16_t elem);
98 virtual bool SetValEntry(std::string const &content, ValEntry *entry);
99 virtual bool SetBinEntry(uint8_t *content, int lgth, BinEntry *entry);
101 virtual ValEntry *InsertValEntry(std::string const &value,
102 uint16_t group, uint16_t elem,
103 TagName const &vr = GDCM_UNKNOWN);
104 virtual BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
105 uint16_t group, uint16_t elem,
106 TagName const &vr = GDCM_UNKNOWN);
107 virtual SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
109 virtual bool IsEmpty() = 0;
110 virtual bool CheckIfEntryExist(uint16_t group, uint16_t elem);
112 // DocEntry related utilities
113 ValEntry *NewValEntry(uint16_t group,uint16_t elem,
114 TagName const &vr = GDCM_UNKNOWN);
115 BinEntry *NewBinEntry(uint16_t group, uint16_t elem,
116 TagName const &vr = GDCM_UNKNOWN);
117 SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem);
119 // DictEntry related utilities
120 DictEntry *NewVirtualDictEntry(uint16_t group,uint16_t elem,
121 TagName const &vr = GDCM_UNKNOWN,
122 TagName const &vm = GDCM_UNKNOWN,
123 TagName const &name = GDCM_UNKNOWN );
126 // DictEntry related utilities
127 DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
128 DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
134 } // end namespace gdcm
135 //-----------------------------------------------------------------------------