Fix mistypings

[gdcm.git] / src / gdcmSQItem.h

diff --git a/src/gdcmSQItem.h b/src/gdcmSQItem.h
index df11a3456d5f5ad5bc999c8229c7c20bc369e542..94918015755301409555a5a2b0c709bdcd1698ab 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: 2005/01/08 15:04:00 $
-  Version:   $Revision: 1.30 $
+  Date:      $Date: 2007/09/17 12:16:01 $
+  Version:   $Revision: 1.56 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -15,8 +15,8 @@
      PURPOSE.  See the above copyright notices for more information.
                                                                                 
 =========================================================================*/
-#ifndef GDCMSQITEM_H
-#define GDCMSQITEM_H
+#ifndef _GDCMSQITEM_H_
+#define _GDCMSQITEM_H_
 
 #include "gdcmDocEntrySet.h"
 #include "gdcmElementSet.h"
@@ -24,84 +24,75 @@
 #include <list>
 #include <fstream>
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE 
 {
 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 
 {
+   gdcmTypeMacro(SQItem);
+
 public:
-   SQItem(int depthLevel);
-   ~SQItem();
+   static SQItem *New(int depthLevel) {return new SQItem(depthLevel);}
 
-   virtual void Print(std::ostream &os = std::cout); 
-   void WriteContent(std::ofstream *fp, FileType filetype);
+   virtual void Print(std::ostream &os = std::cout, 
+                      std::string const &indent = "" ); 
+   void WriteContent(std::ofstream *fp, FileType filetype,
+                           bool insideMetaElements, bool insideSequence);
+   uint32_t ComputeFullLength();
 
-   /// \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.      
    bool AddEntry(DocEntry *Entry); // add to the List
    bool RemoveEntry(DocEntry *EntryToRemove);
-   bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
+   void ClearEntry();
   
-   DocEntry *GetDocEntry(uint16_t group, uint16_t element);
-   
-   bool SetEntry(std::string const &val, uint16_t group, 
-                                         uint16_t element);
-    
-   std::string GetEntry(uint16_t group, uint16_t element);
+   DocEntry *GetFirstEntry();
+   DocEntry *GetNextEntry();
 
-   /// \brief   returns the ordinal position of a given SQItem
-   int GetSQItemNumber() { return SQItemNumber; };
+   DocEntry *GetDocEntry(uint16_t group, uint16_t elem);
 
-   /// \brief   Sets the ordinal position of a given SQItem
-   void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
+   bool IsEmpty() { return DocEntries.empty(); }
 
-   /// Accessor on \ref SQDepthLevel.
-   int GetDepthLevel() { return SQDepthLevel; }
-                                                                                
-   /// Accessor on \ref SQDepthLevel.
-   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
+   /// \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 BaseTagKey.
-   void SetBaseTagKey( BaseTagKey const &key ) { BaseTagKeyNested = key; }
+   ///  \brief Accessor on  SQDepthLevel.
+   int GetDepthLevel() { return SQDepthLevel; }                                                                             
 
-   /// Accessor on \ref BaseTagKey.
-   BaseTagKey const &GetBaseTagKey() const { return BaseTagKeyNested; }
+   ///  \brief Accessor on  SQDepthLevel.
+   void SetDepthLevel(int depth) { SQDepthLevel = depth; }
 
-   void Initialize();
-   DocEntry *GetNextEntry();
+   virtual void Copy(DocEntrySet *set);
 
 protected:
-// Variables that need to be access in subclasses
+   SQItem(int depthLevel);
+   ~SQItem();
 
-   /// \brief Chained list of (Elementary) Doc Entries
+// Variables that need to be accessed in subclasses
+   /// \brief Chained list of Doc Entries
    ListDocEntry DocEntries;
-   /// Chained list iterator, used to visit the TagHT variable
+   /// Iterator, used to visit the entries
    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
+   /// \brief Sequences can be nested. This  SQDepthLevel represents
    ///        the level of the nesting of instances of this class.
-   ///        \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
+   ///         SQDepthLevel and its  SeqEntry::SQDepthLevel
    ///        counterpart are only defined on printing purposes
-   ///        (see \ref Print).
+   ///        (see  Print).
    int SQDepthLevel;
 
-   /// \brief A TagKey of a DocEntry nested in a sequence is prepended
-   ///        with this BaseTagKey.
-   BaseTagKey BaseTagKeyNested;
-
    /// \brief SQ Item ordinal number 
    int SQItemNumber;
 };