src/gdcmSQItem.h

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