src/gdcmSeqEntry.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSeqEntry.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/18 12:16:10 $
   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
  19 #ifndef GDCMSQDOCENTRY_H
  20 #define GDCMSQDOCENTRY_H
  21
  22 #include "gdcmDocEntry.h"
  23
  24 #include <list>
  25
  26 namespace gdcm
  27 {
  28 class SQItem;
  29 //-----------------------------------------------------------------------------
  30 typedef std::list<SQItem *> ListSQItem;
  31 //-----------------------------------------------------------------------------
  32 /**
  33  * \brief a SeqEntry (as opposed to a ValEntry) is a non elementary DocEntry.
  34  *        It is composed by a set of SQItems.
  35  *        Each SQItem is composed by a set of DocEntry
  36  *        A DocEntry may be a SeqEntry
  37  *        ... and so forth
  38  */
  39 class GDCM_EXPORT SeqEntry : public DocEntry
  40 {
  41 public:
  42    SeqEntry( DictEntry *e);
  43    SeqEntry( DocEntry *d, int depth );
  44    ~SeqEntry();
  45
  46    void Print(std::ostream &os = std::cout, std::string const & indent = "" );
  47    void WriteContent(std::ofstream *fp, FileType filetype);
  48
  49    /// returns the SQITEM chained List for this SeQuence.
  50    ListSQItem const &GetSQItems() const { return Items; }
  51    SQItem *GetFirstEntry();
  52    SQItem *GetNextEntry();
  53
  54    /// Sets the delimitor mode
  55    void SetDelimitorMode(bool dm) { DelimitorMode = dm; }
  56
  57    /// Sets the Sequence Delimitation Item
  58    void SetSequenceDelimitationItem(DocEntry *e) { SeqTerm = e;}
  59
  60    void AddEntry(SQItem *it, int itemNumber);
  61    SQItem *GetSQItemByOrdinalNumber(int itemNumber);
  62
  63    /// Gets the depth level
  64    int GetDepthLevel() const { return SQDepthLevel; }
  65
  66    /// Sets the depth level of a Sequence Entry embedded in a SeQuence
  67    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
  68
  69 protected:
  70
  71 private:
  72 // Variables
  73
  74    /// If this Sequence is in delimitor mode (length =0xffffffff) or not
  75    bool DelimitorMode;
  76
  77    /// Chained list of SQ Items
  78    ListSQItem Items;
  79    /// iterator on the SQItems of the current SeqEntry
  80    ListSQItem::iterator ItSQItem;
  81
  82    /// sequence terminator item
  83    DocEntry *SeqTerm;
  84
  85    /// \brief Defines the depth level of this \ref SeqEntry inside
  86    ///        the (optionaly) nested sequences. \ref SQDepthLevel
  87    ///        and its \ref SQItem::SQDepthLevel counterpart
  88    ///        are only defined on printing purposes (see \ref Print).
  89    int SQDepthLevel;
  90 };
  91 } // end namespace gdcm
  92 //-----------------------------------------------------------------------------
  93 #endif
  94