src/gdcmDocEntrySet.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocEntrySet.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/02/04 14:49:01 $
   7   Version:   $Revision: 1.48 $
   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 //-----------------------------------------------------------------------------
  28 class DocEntry;
  29 class ValEntry;
  30 class BinEntry;
  31 class SeqEntry;
  32 class DictEntry;
  33
  34 typedef std::string BaseTagKey;
  35
  36 //-----------------------------------------------------------------------------
  37 /**
  38  * \brief
  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 ].
  54  *
  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.
  58  */
  59 class GDCM_EXPORT DocEntrySet : public Base
  60 {
  61 public:
  62    /// Canonical Constructor
  63    DocEntrySet() {};
  64    /// Canonical Destructor
  65    virtual ~DocEntrySet() {};
  66
  67    /// \brief write any type of entry to the entry set
  68    virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0;
  69
  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;
  82    /// Gets the first ValEntry of set (for Python users)
  83    virtual ValEntry *GetFirstValEntry()=0;
  84    /// Gets the next ValEntry of set  (for Python users)
  85    virtual ValEntry *GetNextValEntry()=0;
  86    virtual std::string GetEntryValue(uint16_t group, uint16_t elem);
  87    virtual void *GetEntryBinArea(uint16_t group, uint16_t elem);
  88    virtual int GetEntryLength(uint16_t group, uint16_t elem);
  89    virtual std::string GetEntryVR(uint16_t group, uint16_t elem);
  90
  91    /// \brief Gets any type of DocEntry, identified by its (group,elem)
  92    virtual DocEntry *GetDocEntry(uint16_t group, uint16_t elem) = 0;
  93    /// \brief Gets a ValEntry, identified by its (group, elem)
  94    virtual ValEntry *GetValEntry(uint16_t group, uint16_t elem);
  95    /// \brief Gets a BinEntry, identified by its (group,elem)
  96    virtual BinEntry *GetBinEntry(uint16_t group, uint16_t elem);
  97    /// \brief Gets a SeqEntry, identified by its (group,elem)
  98    virtual SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem);
  99
 100    virtual bool SetValEntry(std::string const &content,
 101                             uint16_t group, uint16_t elem);
 102    virtual bool SetBinEntry(uint8_t *content, int lgth,
 103                             uint16_t group, uint16_t elem);
 104    virtual bool SetValEntry(std::string const &content, ValEntry *entry);
 105    virtual bool SetBinEntry(uint8_t *content, int lgth, BinEntry *entry);
 106
 107    virtual ValEntry *InsertValEntry(std::string const &value,
 108                                     uint16_t group, uint16_t elem,
 109                                     TagName const &vr = GDCM_UNKNOWN);
 110    virtual BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
 111                                     uint16_t group, uint16_t elem,
 112                                     TagName const &vr = GDCM_UNKNOWN);
 113    virtual SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
 114    /// tells us if the set contains no entry
 115    virtual bool IsEmpty() = 0;
 116    virtual bool CheckIfEntryExist(uint16_t group, uint16_t elem);
 117
 118 // DocEntry  related utilities
 119    ValEntry *NewValEntry(uint16_t group,uint16_t elem,
 120                          TagName const &vr = GDCM_UNKNOWN);
 121    BinEntry *NewBinEntry(uint16_t group, uint16_t elem,
 122                          TagName const &vr = GDCM_UNKNOWN);
 123    SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem);
 124
 125 // DictEntry  related utilities
 126    DictEntry *NewVirtualDictEntry(uint16_t group,uint16_t elem,
 127                                   TagName const &vr     = GDCM_UNKNOWN,
 128                                   TagName const &vm     = GDCM_UNKNOWN,
 129                                   TagName const &name   = GDCM_UNKNOWN );
 130
 131 protected:
 132 // DictEntry  related utilities
 133    DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
 134    DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
 135                            TagName const &vr);
 136
 137 private:
 138 };
 139
 140 } // end namespace gdcm
 141 //-----------------------------------------------------------------------------
 142 #endif
 143