src/gdcmDocEntrySet.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocEntrySet.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/25 11:11:58 $
   7   Version:   $Revision: 1.43 $
   8
   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.
  12
  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.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMDOCENTRYSET_H
  20 #define GDCMDOCENTRYSET_H
  21
  22 #include "gdcmBase.h"
  23 #include <fstream>
  24
  25 namespace gdcm
  26 {
  27 class DocEntry;
  28 class ValEntry;
  29 class BinEntry;
  30 class SeqEntry;
  31 class DictEntry;
  32
  33 typedef std::string BaseTagKey;
  34 //-----------------------------------------------------------------------------
  35
  36 /**
  37  * \brief
  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 ].
  53  *
  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.
  57  */
  58 class GDCM_EXPORT DocEntrySet : public Base
  59 {
  60 friend class FileHelper;
  61 public:
  62    DocEntrySet() {};
  63    virtual ~DocEntrySet() {};
  64
  65    // ------- '... =0;' stands for 'Pure Virtual'
  66
  67    /// \brief Remove all Entry in the entry set
  68    virtual void ClearEntry() = 0;
  69
  70    /// \brief adds any type of entry to the entry set
  71    virtual bool AddEntry(DocEntry *Entry) = 0;
  72
  73    /// \brief Removes any type of entry out of the entry set, and destroys it
  74    virtual bool RemoveEntry(DocEntry *EntryToRemove)=0;
  75
  76    /// \brief Removes any type of entry out of the entry set, DOESN'T destroy it
  77    virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove)= 0;
  78
  79    /// \brief write any type of entry to the entry set
  80    virtual void WriteContent (std::ofstream *fp,
  81                               FileType filetype) = 0;
  82
  83    /// \brief Gets any type of DocEntry, identified by its (group,elem)
  84    virtual DocEntry *GetDocEntry(uint16_t group,
  85                                  uint16_t elem) = 0;
  86
  87    /// \brief Gets a ValEntry, identified by its (group,elem)
  88    virtual ValEntry *GetValEntry(uint16_t group,
  89                                  uint16_t elem) = 0;
  90    /// \brief Gets a BinEntry, identified by its (group,elem)
  91    virtual BinEntry *GetBinEntry(uint16_t group,
  92                                  uint16_t elem) = 0;
  93
  94    /// \brief Gets a SeqEntry, identified by its (group,elem)
  95    virtual SeqEntry *GetSeqEntry(uint16_t group,
  96                                  uint16_t elem) = 0;
  97
  98    /// \brief Gets the 'string value' of a ValEntry
  99    ///        identified by its (group,elem) - Sorry for the name !...-
 100    virtual std::string GetEntryValue(uint16_t group, uint16_t elem) = 0;
 101
 102    virtual DocEntry *GetFirstEntry()=0;
 103    virtual DocEntry *GetNextEntry()=0;
 104
 105    DictEntry *NewVirtualDictEntry(uint16_t group,
 106                                   uint16_t elem,
 107                                   TagName const &vr     = GDCM_UNKNOWN,
 108                                   TagName const &vm     = GDCM_UNKNOWN,
 109                                   TagName const &name   = GDCM_UNKNOWN );
 110
 111 protected:
 112 // DocEntry  related utilities
 113
 114    ValEntry *NewValEntry(uint16_t group,uint16_t elem,
 115                          TagName const &vr = GDCM_UNKNOWN);
 116    BinEntry *NewBinEntry(uint16_t group,uint16_t elem,
 117                          TagName const &vr = GDCM_UNKNOWN);
 118    SeqEntry *NewSeqEntry(uint16_t group,uint16_t elem);
 119
 120 // DictEntry  related utilities
 121    DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
 122    DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
 123                            TagName const &vr);
 124 };
 125
 126 } // end namespace gdcm
 127 //-----------------------------------------------------------------------------
 128 #endif
 129