1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntrySet.h,v $
6 Date: $Date: 2005/10/24 16:00:47 $
7 Version: $Revision: 1.61 $
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
23 #include "gdcmVRKey.h"
24 #include "gdcmTagKey.h"
30 //-----------------------------------------------------------------------------
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)
43 * - \ref SQItem 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 /// Gets the first entry of any type of set
77 virtual DocEntry *GetFirstEntry()=0;
78 /// Gets the next entry of any type of set
79 virtual DocEntry *GetNextEntry()=0;
81 virtual std::string GetEntryString(uint16_t group, uint16_t elem);
82 virtual void *GetEntryBinArea(uint16_t group, uint16_t elem);
83 virtual int GetEntryLength(uint16_t group, uint16_t elem);
84 virtual std::string GetEntryForcedAsciiValue(uint16_t group, uint16_t elem);
86 /// \brief Gets any type of DocEntry, identified by its (group,elem)
87 virtual DocEntry *GetDocEntry(uint16_t group, uint16_t elem) = 0;
88 /// \brief Gets a DataEntry, identified by its (group, elem)
89 DataEntry *GetDataEntry(uint16_t group, uint16_t elem);
90 /// \brief Gets a SeqEntry, identified by its (group,elem)
91 SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem);
93 bool SetEntryString(std::string const &content,
94 uint16_t group, uint16_t elem);
95 bool SetEntryBinArea(uint8_t *content, int lgth,
96 uint16_t group, uint16_t elem);
97 bool SetEntryString(std::string const &content, DataEntry *entry);
98 bool SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry);
100 DataEntry *InsertEntryString(std::string const &value,
101 uint16_t group, uint16_t elem,
102 VRKey const &vr = GDCM_VRUNKNOWN);
103 DataEntry *InsertEntryBinArea(uint8_t *binArea, int lgth,
104 uint16_t group, uint16_t elem,
105 VRKey const &vr = GDCM_VRUNKNOWN);
106 SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
107 /// tells us if the set contains no entry
108 virtual bool IsEmpty() = 0;
109 virtual bool CheckIfEntryExist(uint16_t group, uint16_t elem);
111 // DocEntry related utilities
112 DataEntry *NewDataEntry(uint16_t group,uint16_t elem,
113 VRKey const &vr = GDCM_VRUNKNOWN);
114 SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem);
117 // DictEntry related utilities
118 DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
119 DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
121 /// To be able to backtrack (Private Sequence, Implicit VR related pb)
122 DocEntry *PreviousDocEntry;
127 } // end namespace gdcm
128 //-----------------------------------------------------------------------------