src/gdcmSeqEntry.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSeqEntry.h,v $
   5   Language:  C++
   6   Date:      $Date: 2004/12/03 20:16:58 $
   7   Version:   $Revision: 1.25 $
   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 class GDCM_EXPORT SeqEntry : public DocEntry
  34 {
  35 public:
  36    SeqEntry( DictEntry* );
  37    SeqEntry( DocEntry* d, int depth );
  38    ~SeqEntry();
  39
  40    void Print(std::ostream &os = std::cout);
  41    void WriteContent(std::ofstream *fp, FileType filetype);
  42
  43    /// returns the SQITEM chained List for this SeQuence.
  44    ListSQItem const & GetSQItems() const { return Items; }
  45
  46    /// Sets the delimitor mode
  47    void SetDelimitorMode(bool dm) { DelimitorMode = dm; }
  48
  49    /// Sets the Sequence Delimitation Item
  50    void SetSequenceDelimitationItem(DocEntry * e) { SeqTerm = e;}
  51
  52    void AddEntry(SQItem *it, int itemNumber);
  53    SQItem *GetSQItemByOrdinalNumber(int itemNumber);
  54
  55    /// Gets the depth level
  56    int GetDepthLevel() const { return SQDepthLevel; }
  57
  58    /// Sets the depth level of a Sequence Entry embedded in a SeQuence
  59    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
  60
  61 protected:
  62
  63 private:
  64 // Variables
  65
  66    /// If this Sequence is in delimitor mode (length =0xffffffff) or not
  67    bool DelimitorMode;
  68
  69    /// Chained list of SQ Items
  70    ListSQItem Items;
  71
  72    /// sequence terminator item
  73    DocEntry *SeqTerm;
  74
  75    /// \brief Defines the depth level of this \ref SeqEntry inside
  76    ///        the (optionaly) nested sequences. \ref SQDepthLevel
  77    ///        and its \ref SQItem::SQDepthLevel counterpart
  78    ///        are only defined on printing purposes (see \ref Print).
  79    int SQDepthLevel;
  80 };
  81 } // end namespace gdcm
  82 //-----------------------------------------------------------------------------
  83 #endif
  84