src/gdcmSeqEntry.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSeqEntry.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/02/04 14:49:01 $
   7   Version:   $Revision: 1.33 $
   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 /**
  34  * \brief a SeqEntry (as opposed to a ValEntry) is a non elementary DocEntry.
  35  *        It is composed by a set of SQItems.
  36  *        Each SQItem is composed by a set of DocEntry
  37  *        A DocEntry may be a SeqEntry
  38  *        ... and so forth
  39  */
  40 class GDCM_EXPORT SeqEntry : public DocEntry
  41 {
  42 public:
  43    SeqEntry( DictEntry *e);
  44    SeqEntry( DocEntry *d, int depth );
  45    ~SeqEntry();
  46
  47    void Print(std::ostream &os = std::cout, std::string const &indent = "" );
  48    void WriteContent(std::ofstream *fp, FileType filetype);
  49
  50    void AddSQItem(SQItem *it, int itemNumber);
  51    void ClearSQItem();
  52    SQItem *GetFirstSQItem();
  53    SQItem *GetNextSQItem();
  54    SQItem *GetSQItem(int itemNumber);
  55    unsigned int GetNumberOfSQItems();
  56
  57    /// Sets the delimitor mode
  58    void SetDelimitorMode(bool dm) { DelimitorMode = dm; }
  59
  60    /// Sets the Sequence Delimitation Item
  61    void SetDelimitationItem(DocEntry *e) { SeqTerm = e;   }
  62    /// Gets the Sequence Delimitation Item
  63    DocEntry *GetDelimitationItem()       { return SeqTerm;}
  64
  65    /// Gets the depth level
  66    int GetDepthLevel() const { return SQDepthLevel; }
  67    /// Sets the depth level of a Sequence Entry embedded in a SeQuence
  68    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
  69
  70 protected:
  71
  72 private:
  73 // Variables
  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