src/gdcmDocEntrySet.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocEntrySet.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/19 13:17:05 $
   7   Version:   $Revision: 1.59 $
   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 "gdcmVRKey.h"
  24 #include "gdcmTagKey.h"
  25
  26 #include <fstream>
  27
  28 namespace gdcm
  29 {
  30 //-----------------------------------------------------------------------------
  31 class DocEntry;
  32 class DataEntry;
  33 class SeqEntry;
  34 class DictEntry;
  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)
  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 ].
  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
  83    virtual std::string GetEntryString(uint16_t group, uint16_t elem);
  84    virtual void *GetEntryBinArea(uint16_t group, uint16_t elem);
  85    virtual int GetEntryLength(uint16_t group, uint16_t elem);
  86    virtual std::string GetEntryForcedAsciiValue(uint16_t group, uint16_t elem);
  87
  88    /// \brief Gets any type of DocEntry, identified by its (group,elem)
  89    virtual DocEntry *GetDocEntry(uint16_t group, uint16_t elem) = 0;
  90    /// \brief Gets a DataEntry, identified by its (group, elem)
  91    DataEntry *GetDataEntry(uint16_t group, uint16_t elem);
  92    /// \brief Gets a SeqEntry, identified by its (group,elem)
  93    SeqEntry *GetSeqEntry(uint16_t group, uint16_t elem);
  94
  95    bool SetEntryString(std::string const &content,
  96                        uint16_t group, uint16_t elem);
  97    bool SetEntryBinArea(uint8_t *content, int lgth,
  98                         uint16_t group, uint16_t elem);
  99    bool SetEntryString(std::string const &content, DataEntry *entry);
 100    bool SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry);
 101
 102    DataEntry *InsertEntryString(std::string const &value,
 103                                    uint16_t group, uint16_t elem,
 104                                    VRKey const &vr = GDCM_VRUNKNOWN);
 105    DataEntry *InsertEntryBinArea(uint8_t *binArea, int lgth,
 106                                     uint16_t group, uint16_t elem,
 107                                     VRKey const &vr = GDCM_VRUNKNOWN);
 108    SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
 109    /// tells us if the set contains no entry
 110    virtual bool IsEmpty() = 0;
 111    virtual bool CheckIfEntryExist(uint16_t group, uint16_t elem);
 112
 113 // DocEntry  related utilities
 114    DataEntry *NewDataEntry(uint16_t group,uint16_t elem,
 115                          VRKey const &vr = GDCM_VRUNKNOWN);
 116    SeqEntry *NewSeqEntry(uint16_t group, uint16_t elem);
 117
 118 // DictEntry  related utilities
 119    DictEntry *NewVirtualDictEntry(uint16_t group,uint16_t elem,
 120                                   VRKey const &vr     = GDCM_VRUNKNOWN,
 121                                   TagName const &vm     = GDCM_UNKNOWN,
 122                                   TagName const &name   = GDCM_UNKNOWN );
 123
 124 protected:
 125 // DictEntry  related utilities
 126    DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
 127    DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
 128                            VRKey const &vr);
 129    /// To be able to backtrack (Private Sequence, Implicit VR related pb)
 130    DocEntry *PreviousDocEntry;
 131
 132 private:
 133 };
 134
 135 } // end namespace gdcm
 136 //-----------------------------------------------------------------------------
 137 #endif
 138