src/gdcmSQItem.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSQItem.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/07 08:46:18 $
   7   Version:   $Revision: 1.29 $
   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 #ifndef GDCMSQITEM_H
  19 #define GDCMSQITEM_H
  20
  21 #include "gdcmDocEntrySet.h"
  22 #include "gdcmElementSet.h"
  23
  24 #include <list>
  25 #include <fstream>
  26
  27 namespace gdcm
  28 {
  29 class DocEntry;
  30
  31 //-----------------------------------------------------------------------------
  32 typedef std::list<DocEntry *> ListDocEntry;
  33 //-----------------------------------------------------------------------------
  34 class GDCM_EXPORT SQItem : public DocEntrySet
  35 {
  36 public:
  37    SQItem(int depthLevel);
  38    ~SQItem();
  39
  40    virtual void Print(std::ostream &os = std::cout);
  41    void WriteContent(std::ofstream *fp, FileType filetype);
  42
  43    /// \brief   returns the DocEntry chained List for this SQ Item.
  44    ListDocEntry const &GetDocEntries() const { return DocEntries; };
  45
  46    /// \brief   adds the passed DocEntry to the DocEntry chained List for
  47    /// this SQ Item.
  48    bool AddEntry(DocEntry *Entry); // add to the List
  49    bool RemoveEntry(DocEntry *EntryToRemove);
  50    bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
  51
  52    DocEntry *GetDocEntryByNumber(uint16_t group, uint16_t element);
  53
  54    bool SetEntryByNumber(std::string const &val, uint16_t group,
  55                                                  uint16_t element);
  56
  57    std::string GetEntryByNumber(uint16_t group, uint16_t element);
  58
  59    /// \brief   returns the ordinal position of a given SQItem
  60    int GetSQItemNumber() { return SQItemNumber; };
  61
  62    /// \brief   Sets the ordinal position of a given SQItem
  63    void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
  64
  65    /// Accessor on \ref SQDepthLevel.
  66    int GetDepthLevel() { return SQDepthLevel; }
  67
  68    /// Accessor on \ref SQDepthLevel.
  69    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
  70
  71    /// Accessor on \ref BaseTagKey.
  72    void SetBaseTagKey( BaseTagKey const &key ) { BaseTagKeyNested = key; }
  73
  74    /// Accessor on \ref BaseTagKey.
  75    BaseTagKey const &GetBaseTagKey() const { return BaseTagKeyNested; }
  76
  77    void Initialize();
  78    DocEntry *GetNextEntry();
  79
  80 protected:
  81 // Variables that need to be access in subclasses
  82
  83    /// \brief Chained list of (Elementary) Doc Entries
  84    ListDocEntry DocEntries;
  85    /// Chained list iterator, used to visit the TagHT variable
  86    ListDocEntry::iterator ItDocEntries;
  87
  88    ///\brief pointer to the HTable of the Document,
  89    ///       (because we don't know it within any DicomDirObject nor any SQItem)
  90    // TagDocEntryHT *PtagHT;
  91
  92 private:
  93
  94    /// \brief Sequences can be nested. This \ref SQDepthLevel represents
  95    ///        the level of the nesting of instances of this class.
  96    ///        \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
  97    ///        counterpart are only defined on printing purposes
  98    ///        (see \ref Print).
  99    int SQDepthLevel;
 100
 101    /// \brief A TagKey of a DocEntry nested in a sequence is prepended
 102    ///        with this BaseTagKey.
 103    BaseTagKey BaseTagKeyNested;
 104
 105    /// \brief SQ Item ordinal number
 106    int SQItemNumber;
 107 };
 108 } // end namespace gdcm
 109 //-----------------------------------------------------------------------------
 110 #endif