src/gdcmElementSet.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmElementSet.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/24 16:00:47 $
   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 GDCMELEMENTSET_H
  20 #define GDCMELEMENTSET_H
  21
  22 #include "gdcmDocEntrySet.h"
  23
  24 #include <map>
  25 #include <iostream>
  26 #include <fstream>
  27
  28 namespace gdcm
  29 {
  30 class SeqEntry;
  31
  32 typedef std::map<TagKey, DocEntry *> TagDocEntryHT;
  33
  34 //-----------------------------------------------------------------------------
  35 /**
  36  * \brief
  37  * \ref ElementSet is based on the STL map<> container
  38  * (see \ref ElementSet::TagHT), as opposed to \ref SQItem
  39  * which is based on an STL list container (see \ref ListDocEntry).
  40  * It contains the 'zero-level- DocEntry (out of any Dicom Sequence)
  41  */
  42 class GDCM_EXPORT ElementSet : public DocEntrySet
  43 {
  44 public:
  45    ElementSet();
  46    ~ElementSet();
  47
  48    virtual void Print(std::ostream &os = std::cout,
  49                       std::string const &indent = "" );
  50
  51    void WriteContent(std::ofstream *fp, FileType filetype);
  52
  53    bool AddEntry(DocEntry *Entry);
  54    bool RemoveEntry(DocEntry *EntryToRemove);
  55    void ClearEntry();
  56
  57    DocEntry *GetFirstEntry();
  58    DocEntry *GetNextEntry();
  59    DocEntry *GetDocEntry(uint16_t group, uint16_t elem);
  60    /// Tells us if the ElementSet contains no entry
  61    bool IsEmpty() { return TagHT.empty(); }
  62
  63 protected:
  64
  65 private:
  66 // Variables
  67    /// Hash Table (map), to provide fast access
  68    TagDocEntryHT TagHT;
  69    /// iterator, used to visit the TagHT variable
  70    TagDocEntryHT::iterator ItTagHT;
  71 };
  72 } // end namespace gdcm
  73 //-----------------------------------------------------------------------------
  74 #endif
  75