src/gdcmSQItem.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSQItem.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/19 13:17:05 $
   7   Version:   $Revision: 1.45 $
   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 //-----------------------------------------------------------------------------
  35 /**
  36  * \brief a SeqEntry is composed by a set of SQItems.
  37  *        Each SQItem is composed by a set of DocEntry
  38  *        A DocEntry may be a SeqEntry
  39  *        ... and so forth
  40  */
  41 class GDCM_EXPORT SQItem : public DocEntrySet
  42 {
  43 public:
  44    SQItem(int depthLevel);
  45    ~SQItem();
  46
  47    virtual void Print(std::ostream &os = std::cout, std::string const &indent = "" );
  48    void WriteContent(std::ofstream *fp, FileType filetype);
  49
  50    bool AddEntry(DocEntry *Entry); // add to the List
  51    bool RemoveEntry(DocEntry *EntryToRemove);
  52    bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
  53    void ClearEntry();
  54    void ClearEntryNoDestroy();
  55    void MoveObject(SQItem *source);
  56
  57    DocEntry *GetFirstEntry();
  58    DocEntry *GetNextEntry();
  59
  60    DocEntry *GetDocEntry(uint16_t group, uint16_t elem);
  61
  62    bool IsEmpty() { return DocEntries.empty(); }
  63
  64    /// \brief   returns the ordinal position of a given SQItem
  65    int GetSQItemNumber() { return SQItemNumber; }
  66    /// \brief   Sets the ordinal position of a given SQItem
  67    void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; }
  68
  69    ///  \brief Accessor on \ref SQDepthLevel.
  70    int GetDepthLevel() { return SQDepthLevel; }
  71
  72    ///  \brief Accessor on \ref SQDepthLevel.
  73    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
  74
  75 protected:
  76 // Variables that need to be accessed in subclasses
  77    /// \brief Chained list of Doc Entries
  78    ListDocEntry DocEntries;
  79    /// Iterator, used to visit the entries
  80    ListDocEntry::iterator ItDocEntries;
  81    /// Iterator, used to visit the Val Entries (for Python users)
  82    ListDocEntry::iterator ItValEntries;
  83
  84 private:
  85    /// \brief Sequences can be nested. This \ref SQDepthLevel represents
  86    ///        the level of the nesting of instances of this class.
  87    ///        \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
  88    ///        counterpart are only defined on printing purposes
  89    ///        (see \ref Print).
  90    int SQDepthLevel;
  91
  92    /// \brief SQ Item ordinal number
  93    int SQItemNumber;
  94 };
  95 } // end namespace gdcm
  96 //-----------------------------------------------------------------------------
  97 #endif