* Reorder source code

[gdcm.git] / src / gdcmSQItem.h

diff --git a/src/gdcmSQItem.h b/src/gdcmSQItem.h
index fc5e755210ecf1e2069f9400ce22cb6f5c924e02..88e1717f2c5574d67adc60a1cb9f32c9c01130f4 100644 (file)
--- a/src/gdcmSQItem.h
+++ b/src/gdcmSQItem.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.h,v $
   Language:  C++
-  Date:      $Date: 2004/10/25 03:35:20 $
-  Version:   $Revision: 1.21 $
+  Date:      $Date: 2005/02/02 16:18:49 $
+  Version:   $Revision: 1.39 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -22,6 +22,7 @@
 #include "gdcmElementSet.h"
 
 #include <list>
+#include <fstream>
 
 namespace gdcm 
 {
@@ -29,64 +30,60 @@ class DocEntry;
 
 //-----------------------------------------------------------------------------
 typedef std::list<DocEntry *> ListDocEntry;
+
 //-----------------------------------------------------------------------------
+/**
+ * \brief a SeqEntry is composed by a set of SQItems.
+ *        Each SQItem is composed by a set of DocEntry
+ *        A DocEntry may be a SeqEntry
+ *        ... and so forth 
+ */ 
 class GDCM_EXPORT SQItem : public DocEntrySet 
 {
 public:
    SQItem(int depthLevel);
    ~SQItem();
 
-   void Print(std::ostream &os = std::cout); 
-   void Write(std::ofstream *fp, FileType filetype);
-
-   /// \brief   returns the DocEntry chained List for this SQ Item.
-   ListDocEntry const &GetDocEntries() const { return DocEntries; };
-   
-   /// \brief   adds the passed DocEntry to the DocEntry chained List for
-   /// this SQ Item.      
-   void AddDocEntry(DocEntry *e) { DocEntries.push_back(e); };
+   virtual void Print(std::ostream &os = std::cout, std::string const & indent = "" ); 
+   void WriteContent(std::ofstream *fp, FileType filetype);
 
-   virtual bool AddEntry(DocEntry *Entry); // add to the List
+   bool AddEntry(DocEntry *Entry); // add to the List
+   bool RemoveEntry(DocEntry *EntryToRemove);
+   bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
+   void ClearEntry();
   
-   DocEntry *GetDocEntryByNumber(uint16_t group, uint16_t element);
-   // FIXME method to write
-   //DocEntry *GetDocEntryByName  (std::string Name);
-   
-   bool SetEntryByNumber(std::string const & val, uint16_t group, uint16_t element);                   
-    
-   std::string GetEntryByNumber(uint16_t group, uint16_t element);
+   DocEntry *GetFirstEntry();
+   DocEntry *GetNextEntry();
+
+   DocEntry *GetDocEntry(uint16_t group, uint16_t elem);
+
+   bool IsEmpty() { return DocEntries.empty(); };
 
    /// \brief   returns the ordinal position of a given SQItem
    int GetSQItemNumber() { return SQItemNumber; };
-
    /// \brief   Sets the ordinal position of a given SQItem
    void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
 
-   /// Accessor on \ref SQDepthLevel.
-   int GetDepthLevel() { return SQDepthLevel; }
-                                                                                
-   /// Accessor on \ref SQDepthLevel.
-   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
+   ///  \brief Accessor on \ref SQDepthLevel.
+   int GetDepthLevel() { return SQDepthLevel; }                                                                             
 
-   /// Accessor on \ref BaseTagKey.
-   void           SetBaseTagKey( BaseTagKey const & key ) { BaseTagKeyNested = key; }
+   ///  \brief Accessor on \ref SQDepthLevel.
+   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
 
-   /// Accessor on \ref BaseTagKey.
-   BaseTagKey const & GetBaseTagKey() const { return BaseTagKeyNested; }
+   ///  \brief Accessor on \ref BaseTagKey.
+   void SetBaseTagKey( BaseTagKey const &key ) { BaseTagKeyNested = key; }
 
+   ///  \brief Accessor on \ref BaseTagKey.
+   BaseTagKey const &GetBaseTagKey() const { return BaseTagKeyNested; }
 
 protected:
 // Variables that need to be access in subclasses
-
-   /// \brief chained list of (Elementary) Doc Entries
+   /// \brief Chained list of (Elementary) Doc Entries
    ListDocEntry DocEntries;
+   /// Chained list iterator, used to visit the TagHT variable
+   ListDocEntry::iterator ItDocEntries;
    
-   ///\brief pointer to the HTable of the Document,
-   ///       (because we don't know it within any DicomDirObject nor any SQItem)
-   TagDocEntryHT *PtagHT;
-
 private:
-
    /// \brief Sequences can be nested. This \ref SQDepthLevel represents
    ///        the level of the nesting of instances of this class.
    ///        \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
@@ -98,10 +95,8 @@ private:
    ///        with this BaseTagKey.
    BaseTagKey BaseTagKeyNested;
 
- 
    /// \brief SQ Item ordinal number 
    int SQItemNumber;
-
 };
 } // end namespace gdcm
 //-----------------------------------------------------------------------------