1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntrySet.h,v $
6 Date: $Date: 2004/12/06 11:37:38 $
7 Version: $Revision: 1.27 $
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
22 #include "gdcmException.h"
33 typedef std::string BaseTagKey;
34 //-----------------------------------------------------------------------------
37 * \ref DocEntrySet is an abstract base class for \ref ElementSet
38 * and \ref SQItem which are both containers for DocEntries.
39 * \ref ElementSet is based on the STL map<> container
40 * (see \ref ElementSet::TagHT), as opposed to \ref SQItem
41 * which is based on an STL list container (see \ref ListDocEntry).
42 * Since the syntax for adding a new element to a map<> or a list<>
43 * differ, \ref DocEntrySet is designed as an adapter to unify the
44 * interfaces of \ref DocEntrySet and \ref ElementSet.
45 * As an illustration of this design, please refer to the implementation
46 * of \ref AddEntry (or any pure virtual method) in both derived classes.
47 * This adapter unification of interfaces enables the parsing of a
48 * DICOM header containing (optionaly heavily nested) sequences to be
49 * written recursively [see \ref Document::ParseDES
50 * which calls \ref Document::ParseSQ, which in turns calls
51 * \ref Document::ParseDES ].
53 * \note Developpers should strongly resist to the temptation of adding
54 * members to this class since this class is designed as an adapter
55 * in the form of an abstract base class.
57 class GDCM_EXPORT DocEntrySet
62 virtual ~DocEntrySet() {};
64 /// \brief adds any type of entry to the entry set (pure vitual)
65 virtual bool AddEntry(DocEntry *Entry) = 0; // pure virtual
66 virtual bool RemoveEntry(DocEntry *EntryToRemove)=0; // pure virtual
67 virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove)=0; // pure virtual
69 /// \brief prints any type of entry to the entry set (pure vitual)
70 virtual void Print (std::ostream & os = std::cout) = 0;// pure virtual
72 /// \brief write any type of entry to the entry set
73 virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0;// pure virtual
75 virtual DocEntry* GetDocEntryByNumber(uint16_t group,
76 uint16_t element) = 0;
77 DocEntry* GetDocEntryByName(TagName const & name);
78 virtual std::string GetEntryByNumber(uint16_t group, uint16_t element) = 0;
79 std::string GetEntryByName(TagName const & name);
80 DictEntry* NewVirtualDictEntry( uint16_t group,
82 TagName const & vr = "unkn",
83 TagName const & fourth = "unkn",
84 TagName const & name = "unkn" );
88 // DocEntry related utilities
89 ValEntry* NewValEntryByNumber(uint16_t group,
91 BinEntry* NewBinEntryByNumber(uint16_t group,
93 DocEntry* NewDocEntryByNumber(uint16_t group,
95 DocEntry* NewDocEntryByNumber(uint16_t group,
98 DocEntry* NewDocEntryByName (TagName const & name);
99 SeqEntry* NewSeqEntryByNumber(uint16_t group,
102 // DictEntry related utilities
103 DictEntry *GetDictEntryByName (TagName const & name);
104 DictEntry *GetDictEntryByNumber(uint16_t, uint16_t);
108 } // end namespace gdcm
109 //-----------------------------------------------------------------------------